Skip to main content
GET
List personal contacts

Headers

Authorization
string
required

value must be Bearer <token> where <token> is api key prefixed with cal_, managed user access token, or OAuth access token

Query Parameters

Part of a contact's name or email, to narrow the list.

Maximum string length: 100
Example:

"jamie"

limit
number
default:50

Maximum number of contacts to return.

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

50

cursor
string

Opaque cursor from pagination.nextCursor. Omit for the first page; keep the same search on subsequent pages.

Response

status
enum<string>
required
Available options:
success,
error
Example:

"success"

data
(Contact on Cal · object | Contact not on Cal · object)[]
required

The contacts on this page, discriminated by type. Only a contact on Cal has a username, booking URL and group booking eligibility.

pagination
object
required