Buscar lista de contatos

GET /v1/contactBooks/{contactBookId}

Exemplo de requisição

curl -X GET "https://app.madmail.com.br/api/v1/contactBooks/{contactBookId}" \
  -H "Authorization: Bearer us_SUA_CHAVE"

Parâmetros

Nome	Local	Obrigatório	Tipo	Descrição
`contactBookId`	path	Sim	string

Respostas

200 — Recupera a lista de contatos

Campo	Tipo	Descrição
`id`	string	ID da lista de contatos
`name`	string	Nome da lista de contatos
`teamId`	number	ID do workspace
`properties`	object	Propriedades personalizadas da lista de contatos
`variables`	array<string>	Variáveis de personalização permitidas para os contatos desta lista
`emoji`	string	Emoji associado à lista de contatos
`doubleOptInEnabled`	boolean	Indica se o double opt-in está ativo para novos contatos
`doubleOptInFrom`	string \| null	Remetente usado nos e-mails de double opt-in (precisa usar um domínio verificado)
`doubleOptInSubject`	string \| null	Assunto usado no e-mail de confirmação do double opt-in
`doubleOptInContent`	string \| null	Conteúdo JSON do editor usado na confirmação do double opt-in
`createdAt`	string	Data e hora de criação
`updatedAt`	string	Data e hora da última atualização
`_count`	object

Exemplo de resposta

{
  "id": "clx1234567890",
  "name": "Newsletter Subscribers",
  "teamId": 1,
  "properties": {
    "customField1": "value1"
  },
  "variables": [
    "registrationCode",
    "company"
  ],
  "emoji": "📙",
  "createdAt": "string",
  "updatedAt": "string"
}

403 — Proibido - a chave de API não tem acesso a esta lista de contatos

Campo	Tipo	Descrição
`error`	string

Exemplo de resposta

{
  "error": "string"
}

404 — Lista de contatos não encontrada

Campo	Tipo	Descrição
`error`	string

Exemplo de resposta

{
  "error": "string"
}