v54

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-01235140905.8 KB
Accounting

Retrieves all contacts in a Xero organisation

get/Contacts

Query parameters

wherestring

Filter by an any element

orderstring

Order by an any element

IDsstring[]

Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.

pageinteger

e.g. page=1 - Up to 100 contacts will be returned in a single API call.

includeArchivedboolean

e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response

summaryOnlyboolean

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.

searchTermstring

Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.

pageSizeinteger

Number of records to retrieve per page

Headers

If-Modified-Sincestring date-time

Only records created or modified since this timestamp will be returned

Response

Success - return response of type Contacts array with 0 to N Contact