APIHub
Back to Explore

Xero Files API

The Xero Files API lets you store, retrieve, update, and delete files and folders in Xero, as well as list their contents and associate files with other Xero objects such as invoices or contacts.

Finance
OAuth
HTTPS
CORS: Unknown
Description enriched …
Visit official documentation

Latency

1101ms p95

Uptime

100.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/Files

Retrieves files

  • pagesize (query, limit) — pass an optional page size value
  • page (query, page) — number of records to skip for pagination
  • sort (query) — values to sort by
POST

/Files

Uploads a File

  • FolderId (query) — pass an optional folder id to save file to specific folder
DELETE

/Files/{FileId}

Deletes a specific file

  • FileId (path, required) — File id for single object
GET

/Files/{FileId}

Retrieves a file by a unique file ID

  • FileId (path, required) — File id for single object
GET

/Associations/{ObjectId}

Retrieves an association object using a unique object ID

  • ObjectId (path, required) — Object id for single object
PUT

/Files/{FileId}

Update a file

  • FileId (path, required) — File id for single object
GET

/Files/{FileId}/Associations

Retrieves a specific file associations

  • FileId (path, required) — File id for single object
POST

/Files/{FileId}/Associations

Creates a new file association

  • FileId (path, required) — File id for single object
DELETE

/Files/{FileId}/Associations/{ObjectId}

Deletes an existing file association

  • FileId (path, required) — File id for single object
  • ObjectId (path, required) — Object id for single object
GET

/Files/{FileId}/Content

Retrieves the content of a specific file

  • FileId (path, required) — File id for single object
GET

/Folders

Retrieves folders

  • sort (query) — values to sort by
POST

/Folders

Creates a new folder

DELETE

/Folders/{FolderId}

Deletes a folder

  • FolderId (path, required) — Folder id for single object
GET

/Folders/{FolderId}

Retrieves specific folder by using a unique folder ID

  • FolderId (path, required) — Folder id for single object
PUT

/Folders/{FolderId}

Updates an existing folder

  • FolderId (path, required) — Folder id for single object
GET

/Inbox

Retrieves inbox folder

16 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://api.xero.com/files.xro/1.0/Files"

api.xero.com · HTTPS only