Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

Use the Authorization header with Bearer scheme.

Examples:

  • API Key: Authorization: Bearer calid_xxxxx

Query Parameters

Search by name, email, phone, or notes.

Example:

"jane"

sortBy
enum<string>
default:name

Field used for sorting contacts.

Available options:
name,
email,
createdAt,
updatedAt
Example:

"name"

sortDirection
enum<string>
default:asc

Sort direction.

Available options:
asc,
desc
Example:

"asc"

createdAtOperator
enum<string>

Comparison operator for createdAtValue.

Available options:
gt,
lt
Example:

"gt"

createdAtValue
string<date-time>

ISO datetime used with createdAtOperator.

Example:

"2026-05-01T00:00:00.000Z"

lastMeetingOperator
enum<string>

Comparison operator for lastMeetingValue.

Available options:
gt,
lt
Example:

"lt"

lastMeetingValue
string<date-time>

ISO datetime used with lastMeetingOperator.

Example:

"2026-05-01T00:00:00.000Z"

limit
integer
default:10

Maximum number of contacts returned.

Required range: 1 <= x <= 100
Example:

10

offset
integer
default:0

Zero-based row offset.

Required range: x >= 0
Example:

0

Response

Contacts retrieved

Contacts retrieved

success
enum<boolean>
required
Available options:
true
data
object
message
string
meta
object