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

# Get Recipients

Retrieve all recipients for your account. You can filter by recipient type (crypto or fiat) using the `type` query parameter.


## OpenAPI

````yaml GET /v1/recipients
openapi: 3.1.0
info:
  title: Hashrails API
  description: >-
    Comprehensive API documentation for Hashrails – easily create, manage, and
    query virtual accounts, recipients, and bank integrations. Secure, scalable,
    and developer-friendly.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.railsfromthecrypt.com
  - url: https://api.hashrails.com
security: []
paths:
  /v1/recipients:
    get:
      tags:
        - Recipients
      summary: Get all recipients
      operationId: PublicRecipientController_getAll
      parameters:
        - name: x-api-key
          in: header
          description: API key for authentication
          required: true
          schema:
            type: string
        - name: type
          required: false
          in: query
          description: Filter by recipient type.
          schema:
            enum:
              - crypto
              - fiat
            type: string
        - name: currency
          required: false
          in: query
          description: Filter by currency (e.g. NGN, USDC).
          schema:
            type: string
        - name: limit
          required: false
          in: query
          description: Number of items per page.
          schema:
            type: integer
            example: 10
        - name: page
          required: false
          in: query
          description: Page number.
          schema:
            type: integer
            example: 1
      responses:
        '200':
          description: Recipients retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Recipients retrieved successfully
                  data:
                    type: array
                    items:
                      oneOf:
                        - $ref: >-
                            #/components/schemas/PublicCryptoRecipientResponseDto
                        - $ref: '#/components/schemas/PublicFiatRecipientResponseDto'
                  meta:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of recipients.
                        example: 25
                      next:
                        type: integer
                        nullable: true
                        description: Next page number, or null if on the last page.
                        example: 2
                      prev:
                        type: integer
                        nullable: true
                        description: Previous page number, or null if on the first page.
                        example: null
              example:
                success: true
                message: Recipients retrieved successfully
                data:
                  - id: rec_01J8V9ZP3A7
                    type: crypto
                    name: My USDT Wallet
                    active: true
                    details:
                      network: Polygon
                      wallet_address: '0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e'
                      symbol: USDT
                    created_at: '2025-10-10T09:15:21Z'
                  - id: rec_02K9W0AQ4B8
                    type: fiat
                    name: Acme Ltd
                    active: true
                    details:
                      bank_name: Wema Bank
                      account_number: '0123456789'
                      account_name: ACME LTD
                      currency: NGN
                    created_at: '2025-10-12T14:30:00Z'
                meta:
                  count: 25
                  next: 2
                  prev: null
components:
  schemas:
    PublicCryptoRecipientResponseDto:
      type: object
      properties:
        id:
          type: string
          example: rec_01J8V9ZP3A7
        type:
          type: string
          example: crypto
        name:
          type: string
          example: Vendor Payment
        active:
          type: boolean
          example: true
        details:
          type: object
          properties:
            network:
              type: string
              example: Polygon
            wallet_address:
              type: string
              example: '0x3fA91D6b84bE2c0BFD7647a92E5B1A2Ec6F8C91e'
            symbol:
              type: string
              example: USDT
        created_at:
          type: string
          example: '2025-10-10T09:15:21Z'
      required:
        - id
        - type
        - name
        - active
        - details
        - created_at
    PublicFiatRecipientResponseDto:
      type: object
      properties:
        id:
          type: string
          example: rec_01J8V9ZP3A7
        type:
          type: string
          example: fiat
        name:
          type: string
          example: Acme Ltd
        active:
          type: boolean
          example: true
        details:
          type: object
          properties:
            bank_name:
              type: string
              example: Wema Bank
            account_number:
              type: string
              example: '0123456789'
            account_name:
              type: string
              example: ACME LTD
            currency:
              type: string
              example: NGN
        created_at:
          type: string
          example: '2025-10-10T09:15:21Z'
      required:
        - id
        - type
        - name
        - active
        - details
        - created_at

````