Xero: Retrieves the connections for this user

← Identity operations · Get started

Operation xero.identity_getconnections

Provider route: GET /connections. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/xero with npm, or alter-sdk-xero with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { XeroIntegration } from "@alter-ai/xero";

async function execute(input: Parameters<XeroIntegration["identity"]["getConnections"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new XeroIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.identity.getConnections(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_xero import XeroIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = XeroIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.identity.get_connections(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.authEventId	string	Optional	Format: uuid

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	array	Root
$[]	Model	Each item	Expand Retrieves the connections for this user — response body — item

Referenced models: Retrieves the connections for this user — response body — item

Schemas

Retrieves the connections for this user — response body — item

Field	Type	Presence	Description and constraints
$	JSON	Root
authEventId	string	Optional	Identifier shared across connections authorised at the same time Format: uuid
createdDateUtc	string	Optional	The date when the user connected this tenant to your app Format: date-time
id	string	Optional	Xero identifier Format: uuid
tenantId	string	Optional	Xero identifier of organisation Format: uuid
tenantName	string	Optional	Xero tenant name
tenantType	string	Optional	Xero tenant type (i.e. ORGANISATION, PRACTICE)
updatedDateUtc	string	Optional	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. Format: date-time

Policy, approvals and errors

SDK function policy ID: xero.identity_getconnections. Catalog operation: identity.getConnections. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source