Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

Token JWT de autenticação

Headers

x-company-id
string

Target company identifier. Required only for global API keys (type=global). Ignored for company API keys and human users.

Query Parameters

Search term to filter contacts. Searches by: contact ID (exact ObjectId), name (partial, case-insensitive), email (partial, case-insensitive), or phone number (partial). Examples: "João", "joao@email.com", "11999998888", "507f1f77bcf86cd799439011".

filters
string

Optional filters (JSON array). Each item: { field, operator, value }. field: contact. (name, email, phone_number, country_code, linkedin_identifier) or the custom field's ObjectId. Operators: eq, neq, contains, not_contains, starts_with, ends_with, is_empty, is_not_empty.

skip_count
string

When true, skips the total count (totalCount comes back null). For UI searches that don't paginate — in large tenants, the count is the most expensive part of the search.

page
string
default:1

Page number (starts at 1)

rowsPerPage
string
default:10

Number of items per page

Response

List of contacts returned successfully

result
any[]
required

List of contacts

meta
any
required

Pagination metadata