GET /Contacts
Servers
- https://api.xero.com/api.xro/2.0
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
If-Modified-Since |
String | No |
Only records created or modified since this timestamp will be returned |
xero-tenant-id |
String | Yes |
Xero identifier for Tenant |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
Integer | No |
e.g. page=1 - Up to 100 contacts will be returned in a single API call. |
where |
String | No |
Filter by an any element |
order |
String | No |
Order by an any element |
includeArchived |
Boolean | No |
e.g. includeArchived=true - Contacts with a status of ARCHIVED will be included in the response |
summaryOnly |
Boolean | No |
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. Default value: false |
IDs[] |
Array | No |
Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call. |
pageSize |
Integer | No |
Number of records to retrieve per page |
searchTerm |
String | No |
Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.