Obtenha uma lista de contatos
Retorna uma lista de contatos com opções avançadas de filtro e paginação.
Como funcionam os filtros:
- Múltiplos filtros são combinados com AND (interseção)
- Filtros de texto são case-insensitive
nameaceita busca parcial (qualquer parte do nome)- Outros campos requerem busca exata (email, city, state, document, occupation)
identificationaceita CPF com ou sem pontuaçãophoneaceita com ou sem formatação (10-11 dígitos)- Filtros de data (
created_startecreated_end) devem ser usados juntos
A resposta inclui totalCount (total de registros), data (array de contatos) e informações de paginação (limit e offset).
Authorization
BearerAuth In: header
Query Parameters
[Optional] Busca parcial no nome do contato (qualquer parte do nome).
[Optional] Telefone do contato. Aceita 10-11 dígitos com ou sem formatação. Retorna erro se formato inválido.
10 <= length <= 15[Optional] CPF/CNPJ do contato. Aceita com ou sem pontuação/traços.
[Optional] Número do documento do contato (busca exata).
[Optional] E-mail do contato (busca exata, case-insensitive).
email[Optional] Cidade do contato (busca exata, case-insensitive).
[Optional] Sigla do estado do contato (ex: SC, SP, PR).
length <= 2[Optional] Ocupação ou profissão do contato (busca exata).
[Optional] Filtra contatos aniversariantes do mês atual (true/false).
[Optional] Data inicial do range (formato: YYYY-MM-DD). DEVE ser usado COM created_end.
date[Optional] Data final do range (formato: YYYY-MM-DD). DEVE ser usado COM created_start.
date[Optional] Número máximo de registros a retornar (padrão: 1000, máximo: 1000).
10001 <= value <= 1000[Optional] Número de registros a pular antes de iniciar a resposta (padrão: 0).
00 <= valueResponse Body
application/json
application/json
application/json
curl -X GET "https://app.advbox.com.br/api/v1/customers"{
"offset": 0,
"limit": 10,
"totalCount": 150,
"data": [
{
"id": 12345,
"name": "João Silva",
"identification": "123.456.789-01",
"document": null,
"cellphone": "(11) 99999-9999",
"gender": "M",
"civil_status": "SOLTEIRO(A)",
"phone": "(11) 3333-4444",
"email": "joao.silva@example.com",
"occupation": "Advogado",
"street": "Rua Exemplo, 123",
"postalcode": "01234-567",
"region": "Centro",
"city": "São Paulo",
"state": "SP",
"country": "BRASIL",
"birthdate": "01/01/1990",
"number_ctps": null,
"number_pis": null,
"number_cid": null,
"notes": "Contato importante",
"origin": "GOOGLE",
"created_at": "2025-01-15 10:30:00",
"lawsuits": [
{
"lawsuit_id": 600,
"process_number": "0001234-56.2025.8.26.0100",
"protocol_number": null
}
]
}
],
"query": {
"limit": "10"
}
}{
"error": "Invalid phone number."
}{
"error": "string",
"message": "string"
}