Pular para o conteúdo principal
GET
Listar contatos

Autorizações

Authorization
string
header
obrigatório

Token JWT de autenticação

Cabeçalhos

x-company-id
string

Identificador da empresa-alvo. Obrigatório apenas para API Keys globais (type=global). Ignorado para API Keys de empresa e usuários humanos.

Parâmetros de consulta

Termo de busca para filtrar contatos. Busca por: ID do contato (ObjectId exato), nome (parcial, case-insensitive), e-mail (parcial, case-insensitive) ou número de telefone (parcial). Exemplos: "João", "joao@email.com", "11999998888", "507f1f77bcf86cd799439011".

filters
string

Filtros opcionais (JSON array). Cada item: { field, operator, value }. field: contact. (name, email, phone_number, country_code, linkedin_identifier) ou ObjectId do campo customizado. Operadores: eq, neq, contains, not_contains, starts_with, ends_with, is_empty, is_not_empty.

skip_count
string

Quando true, pula a contagem total (totalCount vem null). Para buscas de UI que não paginam — em tenants grandes o count é a parte mais cara da busca.

sort_by
enum<string>

Coluna para ordenar a base inteira: name, email, phone_number, createdAt ou updatedAt. Sem sort_by a ordem não é garantida (comportamento anterior).

Opções disponíveis:
name,
email,
phone_number,
createdAt,
updatedAt
sort_order
enum<string>
padrão:desc

Sentido da ordenação. Só vale junto com sort_by.

Opções disponíveis:
asc,
desc
page
string
padrão:1

Número da página (começa em 1)

rowsPerPage
string
padrão:10

Quantidade de itens por página

Resposta

Lista de contatos retornada com sucesso

result
any[]
obrigatório

Lista de contatos

meta
any
obrigatório

Metadados da paginação