Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Xero Identity API

The Identity API from Xero — 2 operation(s) for identity.

Xero Identity API is one of 10 APIs that Xero publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Identity. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 2 operations across 2 paths, and defines 1 schema. It is described by OpenAPI 3.0.0, at version 11.1.0.

Requests are made against a single base URL, https://api.xero.com/api.xro/2.0.

2 operations 2 paths 1 schemas 1 DELETE1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
11.1.0
Base URL
https://api.xero.com/api.xro/2.0
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Xero Identity API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 16 scopes.

  • OAuth2 — For more information

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 DELETE, 1 GET. Each is listed below with its method, path, parameters, and response codes.

Identity 2
GET
/Connections
Xero Retrieves the connections for this user
getConnections 1 param → 200
DELETE
/Connections/{id}
Xero Deletes a connection for this user (i.e. disconnect a tenant)
deleteConnection 1 param → 204404

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Connection (7 properties). Each schema is shown below with its type and property counts.

Connection
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xero-identity-api-openapi.yml Raw ↑

Other APIs Xero publishes across the network.

Xero Accounting API
Xero Asset API
Xero BankFeeds API
Xero Files API
Xero Finance API
Xero PayrollAu API
Xero PayrollNz API
Xero PayrollUk API
Xero Project API