List all recipients
GET {{baseUrl}}/v1/addressBook/recipients
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
address | string | Filters results to fetch only address book recipients with the provided address. | |
chain | string | Filters results to fetch only address book recipients with the provided chain. | |
email | string | Filters results to fetch only address book recipients that have the provided email in their metadata. | |
status | string | Filters results to fetch only address book recipients that have the provided status. | |
from | string | Queries items created since the specified date-time (inclusive). | |
to | string | Queries items created before the specified date-time (inclusive). | |
pageBefore | string | 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.
The items will be returned in the natural order of the collection.
The resource will return the first page if neither pageAfter nor pageBefore are specified.
SHOULD NOT be used in conjuction with pageAfter.
|
| pageAfter | string | | A collection ID value used for pagination.
It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after
the id, with n being specified by pageSize.
The items will be returned in the natural order of the collection.
The resource will return the first page if neither pageAfter nor pageBefore are specified.
SHOULD NOT be used in conjuction with pageBefore.
|
| pageSize | number | | 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 avoided, the collection will determine the page size itself. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"id":"2b9f9ed9-ac9d-5f6e-954b-a29e03ee3259","chain":"ETH","address":"0x8381470ed67c3802402dbbfa0058e8871f017a6f","metadata":{"nickname":"Min's Test"},"status":"active","createDate":"2023-08-17T13:00:14.579175Z","updateDate":"2023-08-17T13:00:14.579175Z"}]}