Xero Get Contacts
Tool to retrieve a list of contacts. Use when you need up-to-date contact information with filtering, paging, or incremental updates.
Write ActionRisk level 2 of 5OAuth connectionFree Action
Tool to retrieve a list of contacts. Use when you need up-to-date contact information with filtering, paging, or incremental updates.
IDsComma-separated list of ContactIDs to filter by.
pageintegerPage number for paginated results (requires pageSize). Iterate incrementing page until an empty result is returned to exhaust all records.
orderstringSort by field, e.g. UpdatedDateUTC DESC.
wherestringOData-style filter for querying contacts. Optimized fields: Name, EmailAddress, AccountNumber, TaxNumber, ContactStatus, City, Country, IsCustomer, IsSupplier. Note: On high-volume accounts, some filters (e.g., IsCustomer, IsSupplier) may be rejected by Xero. If a filter fails o…
pageSizeintegerNumber of contacts per page (requires page).
ContactIDstringXero ContactID. If provided, fetches a single contact at /Contacts/{ContactID}.
searchTermstringCase-insensitive search across Name, FirstName, LastName, ContactNumber, CompanyNumber, EmailAddress.
summaryOnlybooleanReturn a lightweight summary-only response when true.
includeArchivedbooleanInclude archived contacts when true.
If-Modified-SincestringUTC timestamp (YYYY-MM-DDThh:mm:ss) to set as the If-Modified-Since header; returns only contacts created or modified since this timestamp.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
OAuth connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.