Xero: Retrieves folders

← Files operations · Get started

Operation xero.files_getfolders

Provider route: GET /files.xro/1.0/Folders. 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["files"]["getFolders"]>[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.files.getFolders(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.files.get_folders(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.sort	string	Optional	One of: Name, Size, CreatedDateUTC
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
$	array	Root
$[]	Model	Each item	Expand Creates a new folder — response body

Referenced models: Creates a new folder — response body

Schemas

Creates a new folder — response body

Field	Type	Presence	Description and constraints
$	JSON	Root
Email	string	Optional	The email address used to email files to the inbox. Only the inbox will have this element.
FileCount	JSON	Optional
FileCount (anyOf 1)	integer	Alternative	The number of files in the folder
FileCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Id	string	Optional	Xero unique identifier for a folder Files Format: uuid
IsInbox	boolean	Optional	to indicate if the folder is the Inbox. The Inbox cannot be renamed or deleted.
Name	string	Optional	The name of the folder

Policy, approvals and errors

SDK function policy ID: xero.files_getfolders. Catalog operation: files.getFolders. 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