Sign in

get/v1/contactBooks/{contactBookId}

Path parameters

contactBookIdstring required
Example:clx1234567890

Response

Retrieve the contact book

idstring required

The ID of the contact book

namestring required

The name of the contact book

teamIdnumber required

The ID of the team

propertiesobject required

Custom properties for the contact book

variablesstring[] required

Allowed personalization variables for contacts in this book

emojistring required

The emoji associated with the contact book

doubleOptInEnabledboolean

Whether double opt-in is enabled for new contacts

doubleOptInFromstring nullable

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

doubleOptInSubjectstring nullable

Subject line used for double opt-in confirmation email

doubleOptInContentstring nullable

Email editor JSON content used for double opt-in confirmation

createdAtstring required

The creation timestamp

updatedAtstring required

The last update timestamp

Example response

{
  "id": "clx1234567890",
  "name": "Newsletter Subscribers",
  "teamId": 1,
  "properties": {
    "customField1": "value1"
  },
  "variables": [
    "registrationCode",
    "company"
  ],
  "emoji": "📙",
  "doubleOptInEnabled": true,
  "doubleOptInFrom": "Newsletter <hello@example.com>",
  "doubleOptInSubject": "Please confirm your subscription"
}

Changes

Changed in 4 of the 27 revisions of this API.17

  • ee7832fe66a62See the full diff
    • ○

      the response property _count/contacts became required for the status 200

      response-property-became-required

    • ○

      added the required property variables to the response with the 200 status

      response-required-property-added

  • 1bc45cd7b94e4See the full diff
    • ○

      added the optional property doubleOptInContent to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property doubleOptInEnabled to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property doubleOptInFrom to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property doubleOptInSubject to the response with the 200 status

      response-optional-property-added

  • da09bf6f14b11See the full diff
    • ○

      endpoint added

      endpoint-added

  • ad91eadfd8ee1See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation