Retrieves all contacts in a Xero organisation
Query parameters
Filter by an any element
Order by an any element
Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
e.g. page=1 - Up to 100 contacts will be returned in a single API call.
e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response
Use summaryOnly=true in GET Contacts and Invoices endpoint to retrieve a smaller version of the response object. This returns only lightweight fields, excluding computation-heavy fields from the response, making the API calls quick and efficient.
Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
Number of records to retrieve per page
Headers
Only records created or modified since this timestamp will be returned
Response
Success - return response of type Contacts array with 0 to N Contact
Example response
{
"Contacts": [
{
"UpdatedDateUTC": "/Date(1573755038314)/",
"BrandingTheme": {
"CreatedDateUTC": "/Date(1573755038314)/"
},
"BatchPayments": {
"BankAccountNumber": "123-456-1111111",
"BankAccountName": "ACME Bank",
"Details": "Hello World",
"Code": "ABC",
"Reference": "Foobar"
},
"Attachments": [
{
"AttachmentID": "00000000-0000-0000-0000-000000000000",
"FileName": "xero-dev.jpg",
"Url": "https://api.xero.com/api.xro/2.0/Accounts/da962997-a8bd-4dff-9616-01cdc199283f/Attachments/sample5.jpg",
"MimeType": "image/jpg"
}
]
}
]
}