Xero: Retrieves a specific user

← Accounting operations · Get started

Operation xero.getuser

Provider route: GET /api.xro/2.0/Users/{UserID}. 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["accounting"]["getUser"]>[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.accounting.getUser(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.accounting.get_user(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.UserID	string	Required within parent	Format: uuid
headers	object	Required within parent	Additional keys: not allowed
headers.xero-tenant-id	string	Required within parent

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
$	Model	Root	Expand Retrieves users — response body

Referenced models: Retrieves users — response body

Schemas

Retrieves users — response body

Field	Type	Presence	Description and constraints
$	object	Root
Users	array	Optional
Users[]	Model	Each item	Expand Retrieves users — response body — Users item

Referenced models: Retrieves users — response body — Users item

Retrieves users — response body — Users item

Field	Type	Presence	Description and constraints
$	object	Root
EmailAddress	string	Optional	Email address of user
FirstName	string	Optional	First name of user
IsSubscriber	boolean	Optional	Boolean to indicate if user is the subscriber
LastName	string	Optional	Last name of user
OrganisationRole	string	Optional	User role that defines permissions in Xero and via API (READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, etc) Known values: READONLY, INVOICEONLY, STANDARD, FINANCIALADVISER, MANAGEDCLIENT, CASHBOOKCLIENT, UNKNOWN, REMOVED
UpdatedDateUTC	string	Optional	Timestamp of last change to user Read only: true
UserID	string	Optional	Xero identifier Format: uuid

Policy, approvals and errors

SDK function policy ID: xero.getuser. Catalog operation: getUser. 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