> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ndovu.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Get all plans for a partner

> Returns a flat list of all viewable investment plans for the partner's country. Filtered by the partner's country configuration.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v3/partners/{shortName}/plans
openapi: 3.0.0
info:
  title: Ndovu Partner API
  description: API for partners distributing Ndovu investment products to their customers.
  version: '3'
  contact: {}
servers:
  - url: https://be-dev-1.dev.ndovu.co
    description: Development
security: []
tags: []
paths:
  /api/v3/partners/{shortName}/plans:
    get:
      tags:
        - partners
      summary: Get all plans for a partner
      description: >-
        Returns a flat list of all viewable investment plans for the partner's
        country. Filtered by the partner's country configuration.
      operationId: PartnerPlansController_getPlans_v3
      parameters:
        - name: shortName
          required: true
          in: path
          description: The unique short name of the partner
          schema:
            type: string
        - name: categoryId
          required: false
          in: query
          description: Filter by category ID
          schema:
            type: number
        - name: fundType
          required: false
          in: query
          description: Filter by fund type
          schema:
            type: string
            enum:
              - INVEST
              - SAVE
        - name: currency
          required: false
          in: query
          description: Filter by currency code (e.g. KES, USD)
          schema:
            type: string
      responses:
        '200':
          description: List of plans available in the partner's country
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LeanPlansListDto'
        '403':
          description: shortName does not match authenticated partner
      security:
        - bearer: []
components:
  schemas:
    LeanPlansListDto:
      type: object
      properties:
        total:
          type: number
        plans:
          type: array
          items:
            $ref: '#/components/schemas/LeanPlanDto'
      required:
        - total
        - plans
    LeanPlanDto:
      type: object
      properties:
        id:
          type: number
        identifier:
          type: string
        name:
          type: string
        coolName:
          type: string
        about:
          type: string
        hint:
          type: string
        imageUrl:
          type: string
        thumbnail:
          type: string
        sector:
          type: string
        fundType:
          type: string
        profitType:
          type: string
        profitTypeDescription:
          type: string
        performance1:
          type: number
        performance3:
          type: number
        performance5:
          type: number
        performance10:
          type: number
        performanceDate:
          type: string
        currency:
          type: string
        minInvestableAmounts:
          type: object
          description: Minimum investable amounts keyed by currency code
        minTopUpAmounts:
          type: object
          description: Minimum top-up amounts keyed by currency code
        tenor:
          type: string
        lockInPeriod:
          type: number
        partialWithdrawable:
          type: boolean
        factSheet:
          type: string
        prospectus:
          type: string
        isInvestable:
          type: boolean
          description: Whether the plan is currently open for investment
        nonInvestableNote:
          type: string
          description: Reason the plan is not investable, if applicable
        category:
          $ref: '#/components/schemas/LeanCategoryDto'
        planType:
          $ref: '#/components/schemas/LeanPlanTypeDto'
        productRiskLevel:
          $ref: '#/components/schemas/LeanProductRiskLevelDto'
        fundManager:
          $ref: '#/components/schemas/LeanFundManagerDto'
        fundCurrency:
          $ref: '#/components/schemas/LeanFundCurrencyDto'
      required:
        - id
        - name
        - fundType
        - profitType
        - currency
        - partialWithdrawable
        - isInvestable
    LeanCategoryDto:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
        displayName:
          type: string
        tagLine:
          type: string
        dotHex:
          type: string
      required:
        - id
        - name
    LeanPlanTypeDto:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
      required:
        - id
        - name
    LeanProductRiskLevelDto:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
      required:
        - id
        - name
    LeanFundManagerDto:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
      required:
        - id
        - name
    LeanFundCurrencyDto:
      type: object
      properties:
        currency:
          type: string
      required:
        - currency
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.