Skip to content

List Contacts

Endpoint

http
GET /unified/accounting/contacts
Integrations supported
  • QuickBooks
  • Wave
  • 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
contact_type
string
The type of the contact
All possible enum values:
  • customer
  • vendor
Required in
  • QuickBooks
  • Wave
created_at
string
This represents the date when the contact was created
Supported in
  • QuickBooks
  • Xero
updated_at
string
This represents the date when the contact was updated
Supported in
  • QuickBooks
  • Xero
tax_number
string
The tax number of the contact
Supported in
  • Xero
name
string
The name of the contact
Supported in
  • Xero
currency
string
The currency of the contact
Supported in
  • Xero
status
string
The status of the contact
All possible enum values:
  • active
  • archived
Supported in
  • Xero

Response Body

result
object[]
List of Contacts
id
string
REQUIRED · The unique identifier for the contact
Supported in
  • QuickBooks
  • Wave
  • Xero
name
string
The name of the contact
Supported in
  • QuickBooks
  • Wave
  • Xero
type
string
The type of the contact
All possible enum values:
  • customer
  • vendor
Supported in
  • QuickBooks
  • Wave
  • Xero
emails
object[]
The emails of the contact
Supported in
  • QuickBooks
  • Wave
  • Xero
email
string
The email of the contact
type
string
The type of the email
tax_number
string
The tax number of the contact
Supported in
  • QuickBooks
  • Xero
status
string
The status of the contact
All possible enum values:
  • active
  • archived
Supported in
  • QuickBooks
  • Wave
  • Xero
currency
string
The currency of the contact
Supported in
  • QuickBooks
  • Wave
  • Xero
company
string
The ID of company the contact belongs to
addresses
object[]
The addresses of the contact
Supported in
  • QuickBooks
  • Wave
  • Xero
id
string
The unique identifier for address
street_1
string
The street 1 address of the contact
street_2
string
The street 2 address of the contact
city
string
The city of the contact
state
string
The state of the contact
country
string
The country of the contact
postal_code
string
The postal code of the contact
type
string
The type of the address
phones
object[]
The phone numbers of the contact
Supported in
  • QuickBooks
  • Wave
  • Xero
number
string
The phone number of the contact
type
string
The type of the phone number
created_at
string
This represents the date when the contact was created
Supported in
  • QuickBooks
  • Wave
  • Xero
updated_at
string
This represents the date when the contact was updated
Supported in
  • QuickBooks
  • Wave
  • Xero
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.