Retrieve a paginated list of Recipients by query parameter(s)

get https://connect.sandbox.plastiq.com/api/recipients

Query Params

payerId

uuid

required

List only Recipients associated with this Payer ID

offset

integer

The number of records you wish to skip before selecting records

limit

integer

Number of items to return

Headers

Trace-Id

string

A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.

End-User-Agent

string

A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.

End-User-Ip

string

The IP address of the end user. Recommended for compliance.

End-User-OS

string

The Operating System of the end user. Recommended for compliance.

End-User-Device-Id

string

A unique identifier for the end user's device. Recommended for compliance.

End-User-Device-Manufacturer

string

The manufacturer of the device used by the end user. Recommended for compliance.

End-User-Device-Model

string

The device model used by the end user. Recommended for compliance.

Responses

Language

Credentials

Bearer

token

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://connect.sandbox.plastiq.com/api/recipients \
3
     --header 'accept: application/json'

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

application/json

200A list of Recipients

400Bad Request

401Unauthorized

403Forbidden

404Not found

500Internal Server Error