XExeroapi
identity

Retrieves the connections for this user

Override the base server url that include version

get/Connections

Request

  • Base URL
    https://api.xero.com
  • URL
    https://api.xero.com/Connections
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token

Query parameters

authEventIdstring uuid

Filter by authEventId

Response

Success - return response of type Connections array with 0 to n Connection

idstring uuid

Xero identifier

tenantIdstring uuid

Xero identifier of organisation

authEventIdstring uuid

Identifier shared across connections authorised at the same time

tenantTypestring

Xero tenant type (i.e. ORGANISATION, PRACTICE)

tenantNamestring

Xero tenant name

createdDateUtcstring date-time

The date when the user connected this tenant to your app

updatedDateUtcstring date-time

The date when the user most recently connected this tenant to your app. May differ to the created date if the user has disconnected and subsequently reconnected this tenant to your app.

Changes

No recorded changes to this operation across all 56 revisions of this API.