List all contacts

Updated:

GET/accounting/{connection_id}/contact

Returns a list of AccountingContacts. Narrow the results with the query parameters before paging, then page through them with limit and offset (the default and maximum page size depend on the integration). Use fields to return only the fields you need and reduce the response size. When the integration supports a total count, it is returned in the X-Total-Count response header. Use each item's id to retrieve, update, or delete it where those operations are supported.

Parameters

limitnumber default=100
offsetnumber default=0
updated_gtedate-time
Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
querystring
Query string to search. eg. email address or name
type enum
org_idstring
The org ID to filter by (reference to AccountingOrganization)
fieldsstring array
Fields to return
rawstring
Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar
connection_idstring required
ID of the connection

Returns

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestring
The contact's display name: the company name for a business, or the person's full name
first_namestring
last_namestring
emails array
The contact's email addresses
telephones array
currencystring
billing_addressobject
shipping_addressobject
is_activeboolean
tax_exemption enum
Valid values:
"FEDERAL_GOV"
"REGION_GOV"
"LOCAL_GOV"
"TRIBAL_GOV"
"CHARITABLE_ORG"
tax_numberstring
The ID/number of the customer's tax number. This is also known as the ABN (Australia), GST Number (New Zealand), VAT Number (UK) or Tax ID Number (US and global).
is_customerboolean
is_supplierboolean
portal_urlstring
URL for the contact’s portal
payment_methods array
company_namestring
identificationstring
contact account numbers such as registration, A membership or identification reference to help to identify and search customers
associated_contacts array
organization_idstring
payment_terms enum
Valid values:
"ON_RECEIPT"
"NET_7"
"NET_10"
"NET_15"
"NET_20"
paymentterm_idstring
balance_amountnumber
Outstanding AR/AP balance for this contact
websitestring
notesstring
metadata array

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/accounting/5de520f96e439b002043d8dc/contact',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-01-01T00:00:00.000Z',
    sort: 'updated_at',
    order: 'asc',
    query: '',
    type: '',
    org_id: '',
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?