Skip to main content
GET
cURL

Field support per integration

Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
boolean
Supported response fields:
string
enum
Available options: COMPANY
string
ContactPerson[]
Address[]
EmailAddress[]
string
If you’re not using the Interactive Authentication Flow, make sure the query parameters environmentName and companyId are correctly populated. You can obtain these values by using the GET Environments and GET Companies endpoints available under the Authentication section.
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: CONTACT_PERSON, COMPANY
string
ContactPerson[]
Address[]
EmailAddress[]
string
PhoneNumber[]
string
If you’re not using the Interactive Authentication Flow, make sure the query parameter companyId is correctly populated. You can obtain this value by using the GET Companies endpoint available under the Authentication section.
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: CONTACT_PERSON, COMPANY
string
ContactPerson[]
Address[]
EmailAddress[]
PhoneNumber[]
string
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: COMPANY
string
Address[]
EmailAddress[]
string
PhoneNumber[]
string
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: CONTACT_PERSON, COMPANY
string
ContactPerson[]
Address[]
EmailAddress[]
PhoneNumber[]
Ensure that the query parameter _companyId_ is correctly filled with the account ID associated with the contact. This value can be retrieved by using the GET Companies endpoint in the Authentication section. Use the returned id as the value for _companyId_.
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: CONTACT_PERSON, COMPANY
string
ContactPerson[]
Address[]
EmailAddress[]
PhoneNumber[]
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
boolean
Supported response fields:
string
enum
Available options: CONTACT_PERSON, COMPANY
string
ContactPerson[]
Address[]
EmailAddress[]
PhoneNumber[]
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
Address[]
string
ContactPerson[]
enum
Available options: CONTACT_PERSON, COMPANY
EmailAddress[]
string
PhoneNumber[]
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
boolean
Supported response fields:
string
Address[]
string
enum
Available options: COMPANY
EmailAddress[]
string
string
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: CONTACT_PERSON, COMPANY
string
ContactPerson[]
Address[]
EmailAddress[]
PhoneNumber[]
string
This endpoint is available only for the following countries: Accounting Plus: Canada, United Kingdom, Ireland
Accounting Standard: United Kingdom, Ireland
Accounting Start: Canada, United Kingdom, Ireland
When handling a new connection in your integration, it is advisable to first determine which subscription your customer is using to ensure compatibility. To do this, you can use the GET Companies call to retrieve all businesses available for the user. The user will then select one of these businesses. It is also a good practice to verify that the active property of the selected business is set to true before proceeding with the integration setup.
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: UNDEFINED
string
ContactPerson[]
Address[]
If you’re not using the Interactive Authentication Flow, make sure the query parameter companyId is correctly populated. You can obtain this value by using the GET Companies endpoint available under the Authentication section. Please use the id field as the companyId.
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: COMPANY
string
ContactPerson[]
Address[]
string
string
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: CONTACT_PERSON, COMPANY
string
ContactPerson[]
Address[]
EmailAddress[]
string
PhoneNumber[]
string
If you’re not using the Interactive Authentication Flow, make sure the query parameter companyId is correctly populated. You can obtain this value by using the GET Companies endpoint available under the Authentication section.
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
boolean
Supported response fields:
string
enum
Available options: COMPANY
string
Address[]
EmailAddress[]
string
PhoneNumber[]
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: COMPANY
string
Address[]
EmailAddress[]
string
PhoneNumber[]
string
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: COMPANY
string
ContactPerson[]
Address[]
EmailAddress[]
string
PhoneNumber[]
string
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: CONTACT_PERSON, COMPANY
string
ContactPerson[]
Address[]
string
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
boolean
Supported response fields:
string
enum
Available options: CONTACT_PERSON, COMPANY
string
ContactPerson[]
Address[]
EmailAddress[]
PhoneNumber[]
string
Xero allows up to six contact persons per company.
Query parameters:
enum
Available options: 5, 10, 20, 50, 100
number
string
boolean
Supported response fields:
string
enum
Available options: UNDEFINED
string
ContactPerson[]
Address[]
PhoneNumber[]
string

Headers

X-API-KEY
string
required

API key

X-ACCOUNT-KEY
string
required

Account key

Query Parameters

page
number
limit
enum<number>
Available options:
5,
10,
20,
50,
100
companyId
string
environmentName
string
email
string
lastModifiedAt
string
name
string
number
string
rawData
boolean

Response

200 - application/json
meta
object
data
object[]
Last modified on July 10, 2026