Skip to main content
GET
/
v1
/
addressBook
/
recipients
/
{id}
Get a recipient
curl --request GET \
  --url https://api-sandbox.circle.com/v1/addressBook/recipients/{id} \
  --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.

Path Parameters

​
id
string<uuid>
required

Universally unique identifier (UUID v4) of a resource.

Example:

"b3d9d2d5-4c12-4946-a09d-953e82fae2b0"

Response

Successfully retrieved an address book recipient.

​
data
object