Allows you to retrieve all contacts in a Xero organisation
GET {{baseUrl}}/Contacts?where=<string>&order=<string>&IDs=<uuid>,<uuid>&page=<integer>&includeArchived=<boolean>
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
where | string | Filter by an any element | |
order | string | Order by an any element | |
IDs | string | Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. | |
page | string | e.g. page=1 - Up to 100 contacts will be returned in a single API call. | |
includeArchived | string | e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
If-Modified-Since | string | Only records created or modified since this timestamp will be returned | |
xero-tenant-id | string | (Required) Xero identifier for Tenant |
RESPONSES
status: OK
{"Id":"04e93d48-e72f-4775-b7dd-15a041fab972","Status":"OK","ProviderName":"Xero API Partner","DateTimeUTC":"/Date(1551399323399)/","Contacts":[{"ContactID":"5cc8cf28-567e-4d43-b287-687cfcaec47c","ContactStatus":"ACTIVE","Name":"Katherine Warren","FirstName":"Katherine","LastName":"Warren","EmailAddress":"kat.warren@clampett.com","BankAccountDetails":"","Addresses":[{"AddressType":"STREET","City":"","Region":"","PostalCode":"","Country":""},{"AddressType":"POBOX","AddressLine1":"","AddressLine2":"","AddressLine3":"","AddressLine4":"","City":"Palo Alto","Region":"CA","PostalCode":"94020","Country":"United States"}],"Phones":[{"PhoneType":"DDI","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""},{"PhoneType":"DEFAULT","PhoneNumber":"847-1294","PhoneAreaCode":"(626)","PhoneCountryCode":""},{"PhoneType":"FAX","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""},{"PhoneType":"MOBILE","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""}],"UpdatedDateUTC":"/Date(1503348544227+0000)/","ContactGroups":[],"IsSupplier":true,"IsCustomer":true,"Balances":{"AccountsReceivable":{"Outstanding":760.0,"Overdue":920.0},"AccountsPayable":{"Outstanding":231.6,"Overdue":360.0}},"ContactPersons":[],"HasAttachments":false,"HasValidationErrors":false},{"ContactID":"3ec601ad-eddc-4ccb-a8ac-736e88293b1b","ContactStatus":"ACTIVE","Name":"Lisa Parker","FirstName":"Lisa","LastName":"Parker","EmailAddress":"lparker@parkerandco.com","BankAccountDetails":"","Addresses":[{"AddressType":"STREET","City":"","Region":"","PostalCode":"","Country":""},{"AddressType":"POBOX","AddressLine1":"","AddressLine2":"","AddressLine3":"","AddressLine4":"","City":"Anchorage","Region":"AK","PostalCode":"99501","Country":"United States"}],"Phones":[{"PhoneType":"DDI","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""},{"PhoneType":"DEFAULT","PhoneNumber":"266-3583","PhoneAreaCode":"(510)","PhoneCountryCode":""},{"PhoneType":"FAX","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""},{"PhoneType":"MOBILE","PhoneNumber":"","PhoneAreaCode":"","PhoneCountryCode":""}],"UpdatedDateUTC":"/Date(1503348546760+0000)/","ContactGroups":[],"IsSupplier":false,"IsCustomer":false,"ContactPersons":[],"HasAttachments":false,"HasValidationErrors":false}]}