Skip to main content
GET
/
v1
/
contacts
Listar contatos
curl --request GET \
  --url https://api.nuvia.ai/v1/contacts \
  --header 'Authorization: Bearer <token>'
{
  "result": [
    "<unknown>"
  ],
  "meta": "<unknown>"
}

Authorizations

​
Authorization
string
header
required

Token JWT de autenticação

Headers

​
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.

Query Parameters

​
search
string

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.

​
page
string
default:1

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

​
rowsPerPage
string
default:10

Quantidade de itens por página

Response

Lista de contatos retornada com sucesso

​
result
any[]
required

Lista de contatos

​
meta
any
required

Metadados da paginação