Skip to main content
GET
cURL

Query Parameters

field_name
string
required

Name of the custom field to search for

field_value
string
required

Value of the custom field to search for

page
integer

Page number (1-based)

page_size
integer

Number of contacts per page (max 100)

structure
enum<string>
default:NESTED

Format of custom fields in response. NESTED returns array of objects with id, field_name, field_value. FLAT returns object with field names as keys.

Available options:
FLAT,
NESTED

Response

Paginated list of contacts

count
integer
required
total_pages
integer
required
current_page
integer
required
page_size
integer
required
results
object[]
required