Retrieve a contact

Updated:

GET/accounting/{connection_id}/contact/{id}

Retrieves a single AccountingContact by its id. Obtain id values from the corresponding list endpoint. Use fields to return only the fields you need.

Parameters

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
idstring required
ID of the Contact

Returns

Response fieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe contact's display name: the company name for a business, or the person's full name
first_namestringNo
last_namestringNo
emailsAccountingEmail[]NoThe contact's email addresses
emails[].emailstringNo
emails[].typeenumNoValues: WORK, HOME, OTHER
telephonesAccountingTelephone[]No
telephones[].telephonestringNo
telephones[].typeenumNoValues: WORK, HOME, OTHER, FAX, MOBILE
currencystringNo
billing_addressobjectNo
billing_address.address1stringNo
billing_address.address2stringNo
billing_address.citystringNo
billing_address.regionstringNoRegional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province.
billing_address.region_codestringNoShort form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province.
billing_address.postal_codestringNo
billing_address.countrystringNo
billing_address.country_codestringNoCountry code for the country, in ISO 3166 A-2 format
shipping_addressobjectNo
shipping_address.address1stringNo
shipping_address.address2stringNo
shipping_address.citystringNo
shipping_address.regionstringNoRegional area of the employee's address. For example, in the U.S., the region is the employee's state; in Canada, the region is the employee’s province.
shipping_address.region_codestringNoShort form for the regional area of the employee's address. For example, in the U.S., the region code is the two-letter abbreviation for the employee’s state; in Canada, the region is the two-letter abbreviation for the employee's province.
shipping_address.postal_codestringNo
shipping_address.countrystringNo
shipping_address.country_codestringNoCountry code for the country, in ISO 3166 A-2 format
is_activebooleanNo
tax_exemptionenumNoValues: FEDERAL_GOV, REGION_GOV, LOCAL_GOV, TRIBAL_GOV, CHARITABLE_ORG, RELIGIOUS_ORG, EDUCATIONAL_ORG, MEDICAL_ORG, RESALE, FOREIGN, OTHER
tax_numberstringNoThe 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_customerbooleanNo
is_supplierbooleanNo
portal_urlstringNoURL for the contact’s portal
payment_methodsAccountingContactPaymentMethod[]No
payment_methods[].idstringNo
payment_methods[].typeenumYesValues: ACH, ALIPAY, CARD, GIROPAY, IDEAL, OTHER, PAYPAL, WIRE, CHECK
payment_methods[].namestringNo
payment_methods[].defaultbooleanNo
company_namestringNo
identificationstringNocontact account numbers such as registration, A membership or identification reference to help to identify and search customers
associated_contactsAccountingAssociatedContact[]No
associated_contacts[].idstringNo
associated_contacts[].namestringNo
associated_contacts[].emailsAccountingEmail[]No
associated_contacts[].emails[].emailstringNo
associated_contacts[].emails[].typeenumNoValues: WORK, HOME, OTHER
organization_idstringNo
payment_termsenumNoValues: ON_RECEIPT, NET_7, NET_10, NET_15, NET_20, NET_25, NET_30, NET_45, NET_60, NET_90, OTHER
paymentterm_idstringNo
balance_amountnumberNoOutstanding AR/AP balance for this contact
websitestringNo
notesstringNo
metadataAccountingMetadata[]No
metadata[].idstringNoThe ID of the custom field definition (from the metadata/metadata endpoint).
metadata[].slugstringNoThe integration's API name (key) of an existing custom field. List valid slugs for this object with the metadata/metadata endpoint; unknown slugs are rejected by the integration.
metadata[].valueobjectNoThe field's value, typed by format: DATE as ISO-8601 (YYYY-MM-DD, or YYYY-MM-DDTHH:MM:SSZ for date-times); NUMBER, PRICE and CURRENCY as a number; BOOLEAN and YES_NO as true/false; MULTIPLE_SELECT as an array of option values; otherwise a string.
metadata[].namespacestringNo
metadata[].formatenumNoThe data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE_SELECT, MULTIPLE_SELECT, MEASUREMENT, PRICE, YES_NO, CURRENCY, URL
metadata[].extra_dataobjectNo

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/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

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