List all recipients

Returns a list of recipients on an account.

Ordered alphabetically by name.

SecurityCommonAuth
Request
query Parameters
accountId
required
string

The ID of the account to work with.

Example: accountId=F50091
limit
integer [ 1 .. 1000 ]
Default: 100

The maximum number of results to return.

Example: limit=200
offset
integer
Default: 0

The number of items to skip before returning results.

Example: offset=100
search
string <= 100 characters

The term to search the records for.

Example: search=Cesar+Treutel
deleted
string

Whether to return deleted recipients

Enum: "true" "false"
status
string

The recipient's status.

Enum: "UNVERIFIED" "PENDING" "AUTHORISED" "REJECTED"
Example: status=AUTHORISED
Responses
200

OK

get/recipients
Request samples 
Response samples 
application/json
{
  • "limit": 200,
  • "offset": 100,
  • "count": 67,
  • "rows": [
    ]
}