Global API
...
Request
Contact

Read

2min

You can read all the contacts from Xero without passing any filters. However, to get only the filtered response results, you can add the following filters as "queryParameters" as shown in the below example.

Param Name

Type

Description

order

String

Order by any element returned

page

String

Up to 100 contacts will be returned per call when the page parameter is used. e.g. page=1

includeArchived

Boolean

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

IDs

String

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

where

String

Filter using the where parameter. We recommend you limit filtering to the optimised elements only.

Example:

Request
Response




Updated 03 Mar 2023
Did this page help you?