API ReferenceCustomersAPI IntegrationRecipients

Get Recipients

Get the details of all active recipients for a customer.

Path parameters

customer_idstringRequired
A unique identifier representing the customer for whom the recipient records are being retrieved.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptional>=1
The page number to retrieve. Use this to navigate through paginated results. Defaults to 1 if not specified.
limitintegerOptional>=1
The maximum number of records to return per page. Defaults to 50 if not specified.

Response

A recipient or recipients were found and their data is returned in the response body.
recipientslist of objects
Array for the recipients.
meta_dataobject
Container for metadata.

Errors