GET api/v1/crm/contato

CRM: busca um contato (id/email/telefone)

Limite: 120 requisições por minuto

Descrição

Busca um único contato do CRM da loja autenticada. Informe um dos filtros: id, e-mail ou telefone. A busca é sempre restrita à 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 — nenhum filtro (id, email ou telefone) informado.
401	Não autorizado — Token ausente, inválido, inativo ou sem permissão.
404	Contato não encontrado para a loja autenticada.
429	Limite de requisições ultrapassada.

Parâmetros de Entrada

Campo	Descrição	Tipo	Tamanho	Obrigatório
id	Identificador do contato. (informe um dos três filtros)	string	24	condic.
email	E-mail do contato.	string	200	condic.
telefone	Telefone do contato.	string	40	condic.

Exemplo de uso:
GET api/v1/crm/contato?email=maria@empresa.com.br
GET api/v1/crm/contato?id=507f1f77bcf86cd799439011

Parâmetros de Retorno

Campo	Descrição	Tipo
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.	string
idsLista	Listas às quais o contato pertence.	array
origem	Origem do contato.	string
tags	Tags do contato.	array
consentimento	Consentimento por canal (email, whatsapp).	object

Exemplo de Resposta

{
  "idContato": "507f1f77bcf86cd799439011",
  "nome": "Maria Souza",
  "email": "maria@empresa.com.br",
  "telefone": "5511999998888",
  "empresa": "Empresa Exemplo Ltda",
  "idEmpresa": "507f1f77bcf86cd799439abc",
  "idsLista": ["507f1f77bcf86cd799439077"],
  "origem": "api",
  "tags": ["cliente-vip"],
  "consentimento": { "email": true, "whatsapp": false }
}