Skip to main content
GET
/
v1
/
contactBooks
cURL
curl --request GET \
  --url https://app.usesend.com/api/v1/contactBooks \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "clx1234567890",
    "name": "Newsletter Subscribers",
    "teamId": 1,
    "properties": {
      "customField1": "value1"
    },
    "variables": [
      "registrationCode",
      "company"
    ],
    "emoji": "📙",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "doubleOptInEnabled": true,
    "doubleOptInFrom": "Newsletter <[email protected]>",
    "doubleOptInSubject": "Please confirm your subscription",
    "doubleOptInContent": "<string>",
    "_count": {
      "contacts": 123
    }
  }
]

Authorizations

​
Authorization
string
header
required

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

Response

200 - application/json

Retrieve contact books accessible by the API key

​
id
string
required

The ID of the contact book

Example:

"clx1234567890"

​
name
string
required

The name of the contact book

Example:

"Newsletter Subscribers"

​
teamId
number
required

The ID of the team

Example:

1

​
properties
object
required

Custom properties for the contact book

Example:
{ "customField1": "value1" }
​
variables
string[]
required

Allowed personalization variables for contacts in this book

Example:
["registrationCode", "company"]
​
emoji
string
required

The emoji associated with the contact book

Example:

"📙"

​
createdAt
string
required

The creation timestamp

​
updatedAt
string
required

The last update timestamp

​
doubleOptInEnabled
boolean

Whether double opt-in is enabled for new contacts

Example:

true

​
doubleOptInFrom
string | null

From address used for double opt-in emails (must use a verified domain)

Example:

"Newsletter <[email protected]>"

​
doubleOptInSubject
string | null

Subject line used for double opt-in confirmation email

Example:

"Please confirm your subscription"

​
doubleOptInContent
string | null

Email editor JSON content used for double opt-in confirmation

​
_count
object