Skip to main content
GET

Authorizations

Authorization
string
header
required

Personal Access Token (PAT) is a Bearer token used for secure API calls. For direct API calls, the PAT is used in the Authorization header as 'Bearer {PAT}'. For MCP usage, configure your PAT in your MCP client settings (e.g., in your IDE's MCP server configuration) - authentication will be handled automatically.

Query Parameters

ids
string

Comma-separated list of contact IDs to retrieve (max 50). When provided, other search/pagination parameters are ignored.

name
string

Filter contacts by name

fax_number
string

Filter contacts by fax number

groups
string

Filter contacts by group name

note
string

Filter contacts by note (comment)

offset
integer
default:0

Offset for pagination

limit
integer
default:50

Limit for pagination (max 50)

Required range: x <= 50
sort
enum<string>
default:name

Field to sort by

Available options:
name,
creation_date,
modification_date
direction
enum<string>
default:asc

Sort direction

Available options:
asc,
desc
shared
boolean
default:false

If true, return shared/corporate contacts. If false, return personal contacts

Response

Response containing a list of contacts

records
object[]

List of contacts

total_count
integer

Total number of contacts matching the query