---
title: "Retrieve a list of recipients according to filters"
method: GET
path: "/recipient"
tags: ["Recipient"]
---

# Retrieve a list of recipients according to filters

`GET /recipient`

## Query parameters

- `bankName` string
- `bankCode` string
- `provider` string
- `search` string
- `firstname` string
- `lastname` string
- `company` string
- `country` string
- `type` 'mobile' | 'bank'
- `msisdn` string
- `iban` string
- `page` number, required
- `limit` number, required

## Headers

- `ApiKey` string, required
- `MerchantId` string, required
- `Environment` 'live' | 'sandbox', required

## Response `200`

- RecipientDto[]
  - `lastname` string, required — Last name of the recipient
  - `firstname` string, required — First name of the recipient
  - `company` string, required — Company name of the recipient
  - `country` string, required — Country of the recipient
  - `type` 'mobile' | 'bank', required — Recipient type
  - `msisdn` string — Recipient phone number (required if type is mobile)
  - `provider` string — Provider used by the recipient (required if type is mobile)
  - `bankName` string — Name of the bank (required if type is bank)
  - `bankCode` string — Bank code (required if type is bank)
  - `id` string, required — Unique identifier of the recipient
  - `createdAt` string, date-time, required — Date of creation of the recipient
  - `updatedAt` string, date-time, required — Date of last update of the recipient
  - `merchantId` string, required — MerchantId of the merchant who created the recipient
  - `accountNumber` string, required — IBAN of the recipient
  - `isActive` boolean, required — Indicates if the recipient is active
  - `metadata` object — Metadata of the recipient. Contains information like recipient kyc
  - `isIrt` boolean — Indicates if transfers are internationnal

## Other responses

- `401` — Wrong credentials
- `500` — Internal error

---

[API](https://skmtc.net/hub2/apis/hub2-service-api.md) · [All operations](https://skmtc.net/hub2/apis/hub2-service-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hub2/hub2-service-api/revisions/adb17b4b80f4/schema)