GET
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

contactBookId
string
required
Example:

"clx1234567890"

Response

Recupera a lista de contatos

id
string
required

ID da lista de contatos

Example:

"clx1234567890"

name
string
required

Nome da lista de contatos

Example:

"Newsletter Subscribers"

teamId
number
required

ID do time

Example:

1

properties
object
required

Propriedades personalizadas da lista de contatos

Example:
variables
string[]
required

Variáveis de personalização permitidas para os contatos desta lista

Example:
emoji
string
required

Emoji associado à lista de contatos

Example:

"📙"

createdAt
string
required

Data e hora de criação

updatedAt
string
required

Data e hora da última atualização

doubleOptInEnabled
boolean

Indica se o double opt-in está ativo para novos contatos

Example:

true

doubleOptInFrom
string | null

Remetente usado nos e-mails de double opt-in (precisa usar um domínio verificado)

Example:

"Newsletter <hello@example.com>"

doubleOptInSubject
string | null

Assunto usado no e-mail de confirmação do double opt-in

Example:

"Please confirm your subscription"

doubleOptInContent
string | null

Conteúdo JSON do editor usado na confirmação do double opt-in

_count
object