GET api/v1/crm/contatos

CRM: lista contatos (busca, lista, paginação)

Limite: 120 requisições por minuto

Descrição

Lista os contatos do CRM da loja autenticada, com busca, filtro por lista/tag e paginação. O retorno é sempre restrito à loja do token.

Obs.: Utilizar tokenAPI (Authorization: Bearer).

Limite de requisições: 120 requisições por minuto.

Códigos de erro:

Código	Descrição
400	Requisição inválida.
401	Não autorizado — Token ausente, inválido, inativo ou sem permissão para este serviço/método.
429	Limite de requisições ultrapassada — Aguarde o próximo minuto.

Parâmetros de Entrada

Campo	Descrição	Tipo	Tamanho	Obrigatório
busca	Texto livre — filtra por nome, e-mail ou telefone.	string	100	não
idLista	Filtra os contatos que pertencem a esta lista.	string	24	não
tag	Filtra os contatos que possuem a tag informada.	string	60	não
pagina	Página (base 0). Padrão 0.	int		não
porPagina	Itens por página (1 a 200). Padrão 50.	int		não

Exemplo de uso:
GET api/v1/crm/contatos?busca=maria&pagina=0&porPagina=50
GET api/v1/crm/contatos?idLista=507f1f77bcf86cd799439011

Parâmetros de Retorno

Campo	Descrição	Tipo
contatos	Lista de contatos da página.	array
idContato	Identificador do contato.	string
nome	Nome do contato.	string
email	E-mail principal.	string
telefone	Telefone principal.	string
empresa	Nome da empresa (texto).	string
idEmpresa	Identificador da empresa vinculada (conta CRM).	string
idsLista	Listas às quais o contato pertence.	array
origem	Origem do contato.	string
total	Total de contatos que atendem ao filtro.	int
pagina	Página atual (base 0).	int
porPagina	Itens por página aplicados.	int

Exemplo de Resposta

{
  "contatos": [
    {
      "idContato": "507f1f77bcf86cd799439011",
      "nome": "Maria Souza",
      "email": "maria@empresa.com.br",
      "telefone": "5511999998888",
      "empresa": "Empresa Exemplo Ltda",
      "idEmpresa": "507f1f77bcf86cd799439abc",
      "idsLista": ["507f1f77bcf86cd799439077"],
      "origem": "api"
    }
  ],
  "total": 1,
  "pagina": 0,
  "porPagina": 50
}