Skip to main content
GET
cURL

What this endpoint returns

This endpoint returns your contacts. Results are always paginated: the contacts for the current page live in data.data, alongside current_page, per_page, and total.

Filtering and pagination

Common use cases

  • Sync your Novacal contacts into a CRM
  • Look up a contact by email before creating a booking
  • Build an internal address book from your bookers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

query
string

Filter contacts whose name or email contains this string.

page
integer

The page of results to return. Defaults to 1.

Required range: x >= 1
Example:

1

per_page
integer

The number of contacts per page, between 1 and 100. Defaults to 15.

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

15

Response

200 - application/json

Paginated contacts response

success
boolean
required

Indicates whether the request was successful

Example:

true

data
object
required