Get Organisation
xero.get_organisation
ActionCRM & salesconnection required
Calls the Xero API with the connection's credentials.
Read the connected organisation's own details, such as its name, base currency and financial year end.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Xero
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}
- Config it needs
- tenant_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, none required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
tenant_id Xero organisation (tenant) id for this call; overrides the connection's. | string | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
organisation The Xero Organisation record, in PascalCase. | object | — |
organisation_id The Xero OrganisationID. | string | — |
name The organisation's display name in Xero. | string | — |
{
"name": "",
"organisation": {},
"organisation_id": ""
}See Get Organisation run in a workflow.
In a technical demo we add the Xero connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.