v2

latestOpenAPI 3.1.02026-08-07750280.6 KB
Contacts

List contacts

Retrieve a paginated list of contacts for the authenticated organization.

get/contacts

Query parameters

limitinteger

Maximum number of contacts to return

Maximum number of contacts to return

offsetinteger

Number of contacts to skip for pagination

Number of contacts to skip for pagination

sortstring nullable

Sort field. Prefix with '-' for descending order. Available: first_name, last_name, email, created_at

Sort field. Prefix with '-' for descending order. Available: first_name, last_name, email, created_at

searchstring nullable

Search in first_name, last_name, email, or phone_number (finds contacts with search term in ANY of these fields)

Search in first_name, last_name, email, or phone_number (finds contacts with search term in ANY of these fields)

filterstring nullable

Advanced filter with AND (&) and OR (|) logic. Format: 'column:value' or 'column:operator:value'. Limits: max 50 conditions, max 20 groups, max 100 items in 'in' operator, max 1000 chars per value. Examples: 'first_name:Mario|last_name:Mario' (OR), 'first_name:Mario&email:gmail.com' (AND).

Advanced filter with AND (&) and OR (|) logic. Format: 'column:value' or 'column:operator:value'. Limits: max 50 conditions, max 20 groups, max 100 items in 'in' operator, max 1000 chars per value. Examples: 'first_name:Mario|last_name:Mario' (OR), 'first_name:Mario&email:gmail.com' (AND).

Response

Successfully retrieved contacts with custom fields

okboolean