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 Files API

Operations available to regular developers

Xero Files 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 Files. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.

This API exposes 18 operations across 11 paths, and defines 8 schemas. 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.

18 operations 11 paths 8 schemas 3 DELETE9 GET4 POST2 PUT

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 Files 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 18

Across 11 paths, the API surfaces 18 operations — 3 DELETE, 9 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Files 18

Operations available to regular developers

GET
/Files
Retrieves files
getFiles 5 params → 200
POST
/Files
Uploads a File to the inbox
uploadFile 2 params body → 201400
GET
/Files/{FileId}
Retrieves a file by a unique file ID
getFile 2 params → 200
PUT
/Files/{FileId}
Update a file
updateFile 3 params body → 200400
DELETE
/Files/{FileId}
Deletes a specific file
deleteFile 2 params → 204
POST
/Files/{FolderId}
Uploads a File to a specific folder
uploadFileToFolder 3 params body → 201400
GET
/Files/{FileId}/Content
Retrieves the content of a specific file
getFileContent 2 params → 200
GET
/Files/{FileId}/Associations
Retrieves a specific file associations
getFileAssociations 2 params → 200
POST
/Files/{FileId}/Associations
Creates a new file association
createFileAssociation 3 params body → 201400
DELETE
/Files/{FileId}/Associations/{ObjectId}
Deletes an existing file association
deleteFileAssociation 3 params → 204
GET
/Associations/{ObjectId}
Retrieves an association object using a unique object ID
getAssociationsByObject 6 params → 200
GET
/Associations/Count
Retrieves a count of associations for a list of objects.
getAssociationsCount 2 params → 200
GET
/Folders
Retrieves folders
getFolders 2 params → 200
POST
/Folders
Creates a new folder
createFolder 2 params body → 200400
GET
/Folders/{FolderId}
Retrieves specific folder by using a unique folder ID
getFolder 2 params → 200
PUT
/Folders/{FolderId}
Updates an existing folder
updateFolder 3 params body → 200400
DELETE
/Folders/{FolderId}
Deletes a folder
deleteFolder 2 params → 204
GET
/Inbox
Retrieves inbox folder
getInbox 1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Association (9 properties), FileObject (8 properties), User (5 properties), Folder (5 properties). Each schema is shown below with its type and property counts.

ObjectGroup
string
The Object Group that the object is in. These roughly correlate to the endpoints that can be used to retrieve the object via the core accounting API.
Folder
object
5 properties 1 required
Association
object
9 properties
Files
object
4 properties
UploadObject
object
4 properties 3 required
FileObject
object
8 properties 4 required
ObjectType
string
The Object Type
User
object
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

xero-files-api-openapi.yml Raw ↑

Other APIs Xero publishes across the network.

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