xero.contacts.get-contacts

Retrieves all contacts in a Xero organisation

Overview

Property	Value
Workflow type	Atomic
Library	App-xero
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Xero API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
xero_tenant_id	string	Yes	—	Xero identifier for Tenant
if_modified_since	string	No	—	Only records created or modified since this timestamp will be returned
where	string	No	—	Filter by an any element
order	string	No	—	Order by an any element
ids	list	No	—	Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
page	integer	No	—	e.g. page=1 - Up to 100 contacts will be returned in a single API call.
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.
searchterm	string	No	—	Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
pagesize	integer	No	—	Number of records to retrieve per page

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Xero API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
xero_tenant_id	string	Yes	—	Xero identifier for Tenant
if_modified_since	string	No	—	Only records created or modified since this timestamp will be returned
where	string	No	—	Filter by an any element
order	string	No	—	Order by an any element
ids	list	No	—	Filter by a comma separated list of ContactIDs. Allows you to retrieve a specific set of contacts in a single call.
page	integer	No	—	e.g. page=1 - Up to 100 contacts will be returned in a single API call.
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.
searchterm	string	No	—	Search parameter that performs a case-insensitive text search across the Name, FirstName, LastName, ContactNumber and EmailAddress fields.
pagesize	integer	No	—	Number of records to retrieve per page
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call GET /Contacts
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform GET /Contacts
* (any state)	fail	failed	Record the failure reason

Outcomes

Outcome	Type	Description	State Data Keys
completed	SUCCESS	The provider accepted the request	status_code, response
failed	FAILURE	The provider rejected the request or was unreachable	failure_reason, failure_type, status_code

Business Errors

Code	Message Template
HTTP_AUTHENTICATION_FAILED	The provider rejected the credential (HTTP {status_code})
HTTP_AUTHORIZATION_FAILED	The credential is not permitted to perform this operation (HTTP {status_code})
HTTP_NOT_FOUND	The provider has no resource at {path} (HTTP 404)
HTTP_RATE_LIMITED	The provider rate-limited this request (HTTP 429)
HTTP_REQUEST_FAILED	The provider returned HTTP {status_code} for {method}
HTTP_RESPONSE_SHAPE_UNEXPECTED	The provider response for {method} {path} could not be parsed as JSON

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "xero.contacts.get-contacts",
  "initial_data": {
    "base_url": "value",
    "xero_tenant_id": "value"
  }
}