Get all recipients

get

https://example.com/entities/{entityId}/recipients

Path Params

entityId

string

required

Query Params

pageIndex

integer

The page to retrieve

pageSize

integer

The page size

country

string

enum

Recipient's Country to filter by

recipientName

string

Recipient's name to filter by

documentType

string

enum

Type of the Recipient Document to filter by

Allowed:

Headers

X-CorrelationID

string

Header parameter to uniquely identifies the request. Must be supplied as an UUID.

X-Channel

string

length ≤ 256

String containing the channel used to originate the request. For example USSD, Web, App.

X-Callback-URL

uri

URL supplied by the client that will be used to return the callback in the form of an HTTP PUT.

X-API-Key

string

It is used to send the pre-shared client API key to the server.

X-User-Bearer

string

required

It is used to send the user’s access token when OAuth 2.0/OIDC authorization framework is used for end-user authentication.

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of recipients

400Bad request.

401An unauthorized execution attempt was detected.

403The received token does not contain any of the required roles.

404There is no resource matching the requested ID or reference.

500An internal error occurred.