Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
ContactGroup

Retrieves the collection of ContactGroup resources.

Retrieves the collection of ContactGroup resources.

get/contact_groups

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

ContactGroup collection

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

Unique identifier for each contact group

namestring

The name of the contact group

contactIdstring nullable

The ID of a contact within the contact group

contactNamestring nullable

The name of a contact within the contact group

isActiveboolean nullable

Whether the contact group is active or not

Example response

[
  {
    "integration": "quickbooks"
  }
]