Skip to main content
GET
Retrieve the organisation
Any valid API key can call this endpoint.

Authorizations

Authorization
string
header
required

An API key. Its scopes decide what it may call: customers:read (List and look up customers.) customers:write (Create customers, and Xero contacts where the organisation allows it.) catalogue:read (List plans and charges.) subscriptions:read (List and look up subscriptions.) subscriptions:write (Create subscriptions, change units, end and restore them.) invoices:read (List and look up invoices.)

Response

Success.

id
string
required
object
string
required
Allowed value: "organisation"
name
string
required
timezone
string
required
default_currency
string | null
required
setup_mode
boolean
required
can_create_xero_contacts
boolean
required

Whether the organisation has allowed the API to create Xero contacts.