Skip to main content
GET
/
v1
/
addressBook
/
recipients
List all recipients
curl --request GET \
  --url https://api-sandbox.circle.com/v1/addressBook/recipients \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "chain": "ALGO",
      "address": "0x8381470ED67C3802402dbbFa0058E8871F017A6F",
      "addressTag": "123456789",
      "metadata": {
        "nickname": "sample nickname",
        "email": "satoshi@circle.com",
        "bns": "sample.circle"
      },
      "status": "pending",
      "createDate": "2020-04-10T02:13:30.000Z",
      "updateDate": "2020-04-10T02:13:30.000Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
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
enum<string>

Filters results to fetch only address book recipients that have the provided status.

Available options:
pending,
inactive,
active,
denied
​
from
string<date-time>

Queries items created since the specified date-time (inclusive).

Example:

"2020-04-10T02:13:30.000Z"

​
to
string<date-time>

Queries items created before the specified date-time (inclusive).

Example:

"2020-04-10T02:13:30.000Z"

​
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
integer

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.

Required range: x >= 1
Example:

5

Response

Successfully retrieved a list of address book recipients.

​
data
object[]