Appearance

List Contact groups ​

Endpoint ​

http
GET /unified/accounting/contact_groups
Integrations supported
  • QuickBooks
  • Xero

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
name
string
The name of the contact group
Supported in
  • Xero
status
string
The status of the contact group
All possible enum values:
  • active
  • archived
Supported in
  • QuickBooks
  • Xero
created_at
string · date-time
This represents the date when the contact group was created
Supported in
  • QuickBooks
updated_at
string · date-time
This represents the date when the contact group was updated
Supported in
  • QuickBooks

Response Body ​

result
object[]
List of Contact groups
id
string
REQUIRED · The unique identifier for contact group
Supported in
  • QuickBooks
  • Xero
name
string
The name of the contact group
Supported in
  • QuickBooks
  • Xero
status
string
The status of the contact group
All possible enum values:
  • active
  • archived
Supported in
  • QuickBooks
  • Xero
created_at
string · date-time
This represents the date when the contact group was created
Supported in
  • QuickBooks
updated_at
string · date-time
This represents the date when the contact group was updated
Supported in
  • QuickBooks
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.