Appearance

List Contacts ​

Endpoint ​

http
GET /unified/accounting/contacts
Integrations supported
  • Brightpearl
  • Coupa
  • FreeAgent
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Sage Intacct
  • Wave
  • Xero
  • Zoho Books
Partial response integrations

For partial response integrations, you will need to fetch the individual resource using the "get" endpoint to get the full response object.

  • Zoho Books

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar
contact_type
string

The type of the contact

All possible enum values:
  • customer
  • vendor
Required in
  • FreeAgent
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Wave
Supported in
  • Xero
status
string

The status of the contact

All possible enum values:
  • active
  • archived
Supported in
  • QuickBooks
  • Xero
created_at
string · date-time

This represents the date when the contact was created

Supported in
  • QuickBooks
  • Xero
updated_at
string · date-time

This represents the date when the contact was updated

Supported in
  • QuickBooks
  • Xero
  • Zoho Books
name
string

The name of the contact

Supported in
  • Coupa
  • QuickBooks
  • Xero
  • Zoho Books
sort_by
string

The field to sort the resource by. Should be in format { fieldName: direction }. The direction can be asc or desc.

Integration specific notes
  • WaveSort will work only when contact_type is 'customer'.
  • Zoho BooksThis should only accept items in ascending order.
All possible enum values:
  • created_at
  • emails
  • name
  • updated_at
Enum support by integration
  • Wave
    • created_at
    • updated_at
    • name
  • Zoho Books
    • emails
    • created_at
    • updated_at
    • name
Supported in
  • Wave
  • Zoho Books
tax_number
string

The tax number of the contact

Supported in
  • Xero
currency
string

The currency of the contact

Supported in
  • Xero

Response Body ​

result
object[]

List of Contacts

id
string
REQUIRED · 

The unique identifier for the contact

Supported in
  • Brightpearl
  • Coupa
  • FreeAgent
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Sage Intacct
  • Wave
  • Xero
  • Zoho Books
name
string

The name of the contact

Supported in
  • Brightpearl
  • Coupa
  • FreeAgent
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Sage Intacct
  • Wave
  • Xero
  • Zoho Books
type
string

The type of the contact

All possible enum values:
  • customer
  • vendor
Supported in
  • Brightpearl
  • Coupa
  • FreeAgent
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Sage Intacct
  • Wave
  • Xero
  • Zoho Books
emails
object[]

The emails of the contact

Supported in
  • Brightpearl
  • Coupa
  • FreeAgent
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Sage Intacct
  • Wave
  • Xero
  • Zoho Books
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
  • Brightpearl
  • Coupa
  • Microsoft Dynamics 365 Business Central
  • QuickBooks
  • Sage Intacct
  • Xero
status
string

The status of the contact

All possible enum values:
  • active
  • archived
Supported in
  • Brightpearl
  • Coupa
  • FreeAgent
  • Oracle Netsuite
  • QuickBooks
  • Sage Intacct
  • Wave
  • Xero
  • Zoho Books
currency
string

The currency of the contact

Supported in
  • Brightpearl
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Wave
  • Xero
  • Zoho Books
company
string

The ID of company the contact belongs to

References: CompanyInfo → id
Supported in
  • Brightpearl
  • FreeAgent
  • Oracle Netsuite
  • Sage Intacct
  • Zoho Books
addresses
object[]

The addresses of the contact

Supported in
  • Brightpearl
  • Coupa
  • FreeAgent
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Sage Intacct
  • 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
  • Brightpearl
  • FreeAgent
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Sage Intacct
  • Wave
  • Xero
  • Zoho Books
number
string

The phone number of the contact

extension
string

The extension of the phone number

type
string

The type of the phone number

created_at
string · date-time

This represents the date when the contact was created

Supported in
  • Brightpearl
  • Coupa
  • FreeAgent
  • Oracle Netsuite
  • QuickBooks
  • Wave
  • Xero
  • Zoho Books
updated_at
string · date-time

This represents the date when the contact was updated

Supported in
  • Brightpearl
  • Coupa
  • FreeAgent
  • Microsoft Dynamics 365 Business Central
  • Oracle Netsuite
  • QuickBooks
  • Wave
  • Xero
  • Zoho Books
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.