Skip to main content
Contacts

List contacts

Returns a list of contacts (customers and leads) in your organization using cursor-based pagination.

GET
/v2/contacts

Query Parameters

  • limit - Number of contacts to return (1-100, default 10)
  • cursor - Cursor from previous response for pagination
  • contactType - Filter by contact type: "customer" (default), "lead", or "all"

Response Format

Returns a list object with:

  • object - Always "list"
  • data - Array of contact objects
  • nextCursor - Cursor for the next page, or null if no more results

Contact Object

Each contact includes:

  • id - Unique contact identifier
  • userId - External user ID from SSO (if set)
  • email - Contact email address
  • name - Contact display name
  • profilePicture - Profile picture URL
  • type - Contact type ("customer" or "lead")
  • companies - Array of companies the contact belongs to
  • customFields - Custom field values
  • postsCreated - Number of posts created
  • commentsCreated - Number of comments created
  • lastActivity - Last activity timestamp

Example

{
  "object": "list",
  "data": [
    {
      "object": "contact",
      "id": "676f0f6765bdaa7d7d760f88",
      "email": "john@example.com",
      "name": "John Doe",
      "type": "customer",
      ...
    }
  ],
  "nextCursor": "eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9"
}

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Query Parameters

limitintegerquerydefault:10

A limit on the number of objects to be returned, between 1 and 100.

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

An opaque cursor for pagination. Use the nextCursor value from a previous response to fetch the next page of results.

Maximum string length: 512
Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
contactTypeenum<string>querydefault:customer

Filter contacts by type. Defaults to "customer".

Available options: customer, lead, all
Example: customer

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Example: 2026-08-19.orbit

Response

application/json

Success

data(object | null)[]required

Array of contacts

nextCursorstring | nullrequired

Cursor for fetching the next page (cursor-based pagination)

Example: eyJpZCI6IjUwN2YxZjc3YmNmODZjZDc5OTQzOTAxMSJ9
objectenum<string>required

Object type identifier

Available options: list
Example: list

Still need help? Ask the team