Skip to main content
GET
List Recipients
Retrieves a list of recipients for the authenticated account. Supports pagination and filtering.

Authorizations

public-api-key
string
header
default:<Your public-api-key>
required
private-secret-key
string
header
default:<Your private-secret-key>
required

Query Parameters

limit
integer
default:20

Maximum number of recipients to return

Required range: 1 <= x <= 100
offset
integer
default:0

Number of recipients to skip for pagination

Required range: x >= 0
national_entity
enum<string>

Filter recipients by national entity type

Available options:
INDIVIDUAL,
ENTITY
country
string

Filter recipients by country

Response

List of recipients retrieved successfully

data
object[]
pagination
object