List all address book recipients
Lists all address book recipients.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The accountId of the end user's custody account to list recipients for. Without accountId or clientEntityId, a Digital Asset Accounts distributor key returns only recipients on the distributor's own entity.
1000662322
Identifier of the end user's client entity to list recipients for.
"a3f1b2c4-d5e6-7890-abcd-ef1234567890"
Filters results to fetch only address book recipients with the provided address.
Filters results to fetch only address book recipients with the provided chain.
Filters results to fetch only address book recipients that have the provided email in their metadata.
Filters results to fetch only address book recipients that have the provided status.
Status of the address book recipient. Payouts require active. pending means the recipient is under risk review, and inactive means it is in a waiting period before it can receive payouts.
pending, pending_verification, pending_additional_information, pending_owner_information, pending_beneficiary_information, denied, inactive, verification_succeeded, active, on_hold, failed, disabled Queries items created since the specified date-time (inclusive) in ISO 8601 format. ISO-8601 UTC date/time format.
"2020-04-10T02:13:30.000Z"
Queries items created before the specified date-time (inclusive) in ISO 8601 format. ISO-8601 UTC date/time format.
"2020-04-10T02:13:30.000Z"
A collection ID value used for pagination. It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.
"def9520a-5280-4089-9b02-3c9ef8fc8514"
A collection ID value used for pagination. It marks the exclusive beginning of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.
"bce1e961-bdb8-4983-a9c2-0b3fbc2614cf"
Limits the number of items to be returned.
Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.
If omitted, the collection will determine the page size itself.
x >= 15
Response
Successfully retrieved a list of address book recipients.