---
title: "Get list of recipients"
method: GET
path: "/v2/recipients"
tags: ["Recipients"]
---

# Get list of recipients

`GET /v2/recipients`

## Request

- Base URL: `https://api.sandbox.payall.com`
- URL: `https://api.sandbox.payall.com/v2/recipients`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `/v2/oauth/token`

## Query parameters

- `page_number` integer
- `page_size` integer
- `id` string, uuid
- `external_id` string

## Response `200`

OK

- union[]
  - union
    - Person: Abstract class. Use it's implementations instead.
      - `id` string, uuid
      - `type` 'Person' | 'Business', required
      - `external_id` string: ID from external system.
      - `email` string, email
      - `first_name` string, required
      - `last_name` string, required
      - `middle_name` string
      - `mobile_number` string
      - `dob` string, date
      - `occupation` 'general_worker' | 'businessman' | 'others' | 'professional' | 'tourist' | 'security_guard' | 'supervisor' | 'house_maid' | 'domestic_helper' | 'house_wife'
      - `registration_address` Address
        - `city` string
        - `street` string
        - `country` string
        - `postal_code` string
        - `unit_number` string
        - `building_name` string
        - `state_province` string
        - `building_number` string
      - `identity_document` IdentityDocument
        - `type` string
        - `type_version_number` string
        - `country_issuing` string
        - `number` string
        - `national_id_number` string
        - `national_id_number_type` string
        - `series` string
        - `issue_date` string, date: Issue date of the identity document, in `YYYY-MM-DD` format. When provided, it must not be in the future — an issue date later than today is rejected when creating or updating a payer or recipient (see error codes PUB4221 for payers and PUB4222 for recipients).
        - `place_of_issue` string
        - `authority_of_issue` string
        - `expiry_date` string, date: Expiry date of the identity document, in `YYYY-MM-DD` format. When provided, it must not be in the past — an expired document is rejected when creating or updating a payer or recipient (see error codes PUB4219 for payers and PUB4220 for recipients).
        - `driver_license_number` string
        - `driver_license_serial_number` string
        - `driver_license_version_number` string
    - Business: Abstract class. Use it's implementations instead.
      - `id` string, uuid
      - `type` 'Person' | 'Business', required
      - `external_id` string: ID from external system.
      - `legal_name` string, required
      - `country` string, iso-3166-alpha-2: Country of registration. 3166-1 alpha-2 value. Hint: It is `GB`, not `UK`.
      - `trade_name` string
      - `phone_number` string
      - `registration_number` string
      - `email` string, email
      - `registration_address` Address
        - `city` string
        - `street` string
        - `country` string
        - `postal_code` string
        - `unit_number` string
        - `building_name` string
        - `state_province` string
        - `building_number` string

---

[API](https://skmtc.dev/payall/apis/payall-m2m-authentication-api.md) - [All operations](https://skmtc.dev/payall/apis/payall-m2m-authentication-api/llms.txt) - [OpenAPI document](https://skmtc.dev/payall/apis/payall-m2m-authentication-api/revisions/5f561eccd6ce?raw)