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

# Get Recipients

> Get all recipients for the current user with optional filters.



## OpenAPI

````yaml GET /v1/recipients
openapi: 3.0.3
info:
  title: Chessa Accounts API
  description: API collection for Chessa Accounts services
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.chessa.ai
security: []
tags:
  - name: User Endpoints
    description: Endpoints related to user management
  - name: Configuration Endpoints
    description: Endpoints for fetching application configurations
  - name: Recipient Endpoints
    description: Endpoints for managing recipients
  - name: Order Endpoints
    description: Endpoints for managing orders
  - name: Rate Endpoints
    description: Endpoints for exchange rates and fees
  - name: Referral Endpoints
    description: Endpoints for managing referrals
paths:
  /v1/recipients:
    get:
      tags:
        - Recipient Endpoints
      summary: Get Recipients
      description: Get all recipients for the current user with optional filters.
      operationId: getRecipients
      parameters:
        - name: currency
          in: query
          schema:
            type: string
            example: NGN
        - name: country
          in: query
          schema:
            type: string
            example: NG
        - name: x-client-id
          in: header
          schema:
            type: string
            example: ''
        - name: x-client-secret
          in: header
          schema:
            type: string
            example: ''
      responses:
        '200':
          description: Success Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  recipients:
                    type: array
                    items:
                      type: object
                      properties:
                        accountName:
                          type: string
                          example: John Doe
                        accountNumber:
                          type: string
                          example: '0123456789'
                        bankCode:
                          type: string
                          example: '058'
                        bankName:
                          type: string
                          example: Guaranty Trust Bank
                        country:
                          type: string
                          example: NG
                        createdAt:
                          type: string
                          example: '2025-01-15T10:30:45.123Z'
                        currency:
                          type: string
                          example: NGN
                        id:
                          type: string
                          example: rec_123456789abcdef
                        type:
                          type: string
                          example: bank_account
                        updatedAt:
                          type: string
                          example: '2025-01-15T10:30:45.123Z'
                    example:
                      - accountName: John Doe
                        accountNumber: '0123456789'
                        bankCode: '058'
                        bankName: Guaranty Trust Bank
                        country: NG
                        createdAt: '2025-01-15T10:30:45.123Z'
                        currency: NGN
                        id: rec_123456789abcdef
                        type: bank_account
                        updatedAt: '2025-01-15T10:30:45.123Z'
                      - accountName: Jane Smith
                        accountNumber: '9876543210'
                        bankCode: '033'
                        bankName: United Bank for Africa
                        country: NG
                        createdAt: '2025-02-20T14:22:33.456Z'
                        currency: NGN
                        id: rec_987654321fedcba
                        type: bank_account
                        updatedAt: '2025-02-20T14:22:33.456Z'
              examples:
                Success Response:
                  value:
                    recipients:
                      - accountName: John Doe
                        accountNumber: '0123456789'
                        bankCode: '058'
                        bankName: Guaranty Trust Bank
                        country: NG
                        createdAt: '2025-01-15T10:30:45.123Z'
                        currency: NGN
                        id: rec_123456789abcdef
                        type: bank_account
                        updatedAt: '2025-01-15T10:30:45.123Z'
                      - accountName: Jane Smith
                        accountNumber: '9876543210'
                        bankCode: '033'
                        bankName: United Bank for Africa
                        country: NG
                        createdAt: '2025-02-20T14:22:33.456Z'
                        currency: NGN
                        id: rec_987654321fedcba
                        type: bank_account
                        updatedAt: '2025-02-20T14:22:33.456Z'
        '401':
          description: Error Response - Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: unauthorized
                  message:
                    type: string
                    example: Invalid client credentials
                  statusCode:
                    type: number
                    example: 401
              examples:
                Error Response - Unauthorized:
                  value:
                    error: unauthorized
                    message: Invalid client credentials
                    statusCode: 401

````