Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

OAuth2 client_credentials grant for server-to-server access. Onboard via your Nova admin to receive a client_id and client_secret, then POST /oauth/token to exchange them for a short-lived access token. Send the token as Authorization: Bearer <access_token> on every authenticated request. Tokens expire after 3600 seconds — refresh by re-exchanging credentials.

Headers

X-Organization-Id
string

ID of the organization the request acts on. Optional when the access token is bound to a specific organization, or when the integration has access to exactly one organization.

Required string length: 32
Pattern: ^org_[A-Za-z0-9]+$
Example:

"org_EkzhrUc3U6C0UbxNBlK7WLz51ofT"

Query Parameters

limit
integer
default:10

The maximum number of items to return.

Required range: 1 <= x <= 100
page
string

Opaque cursor from a previous response next_page_url; returns the results after it

Required string length: 33
Pattern: ^page_[A-Za-z0-9]+$
Example:

"page_5dr8SFDbv7rZ2aj4Qm9XcLpT2wHk"

page_before
string

Opaque cursor from a previous response previous_page_url; returns the results before it

Required string length: 33
Pattern: ^page_[A-Za-z0-9]+$
Example:

"page_5dr8SFDbv7rZ2aj4Qm9XcLpT2wHk"

id
string[]

Return only the resources with these ids. Repeat the parameter for each id (max 100). All matches return in one page.

NOTE: cannot be combined with page, page_before, or limit.

Required array length: 1 - 100 elements
Required string length: 32
Pattern: ^cnt_[A-Za-z0-9]+$

Response

List of contacts

Type: List A page of results

object
enum<string>
required

Object type identifier.

Available options:
list
Example:

"list"

data
object[]
required

The page of items.

next_page_url
string | null
required

URL for the next page of the list, or null when there are no more pages.

Example:

"/v1/contacts?page=page_5dr8SFDbv7rZ2aj4&limit=10"

previous_page_url
string | null
required

URL for the previous page of the list, or null when there are none.

Example:

"/v1/contacts?page_before=page_8VtqLBv3xJpY7mk2&limit=10"

has_more
boolean
required
deprecated

Whether there are more items available after this page. Deprecated: next_page_url is non-null exactly when more pages exist.

url
string
required
deprecated

Path identifying this list. Deprecated: on lists embedded in another object, or returned by a create, it may not be a GET endpoint you can call. Follow next_page_url / previous_page_url to paginate.

Example:

"/v1/contacts"