Xero Files API API

by xero.com

Overview

These endpoints are specific to Xero Files API

Xero Files API is a finance API from xero.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 16 endpoints.

At a glance

Authentication: OAuth
HTTPS: Yes
CORS: Unknown
Category: Finance
Base URL: https://api.xero.com/files.xro/1.0/
Version: 2.9.4
Endpoints: 16
OpenAPI: Specification ↗
Spec updated: 2021-02-25

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL

curl -X GET "https://api.xero.com/files.xro/1.0/Files" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

JavaScript

const response = await fetch("https://api.xero.com/files.xro/1.0/Files", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "GET",
    "https://api.xero.com/files.xro/1.0/Files",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

Method	Path	What it does
GET	`/Associations/{ObjectId}`	Retrieves an association object using a unique object ID
GET	`/Files`	Retrieves files
POST	`/Files`	Uploads a File
GET	`/Files/{FileId}`	Retrieves a file by a unique file ID
PUT	`/Files/{FileId}`	Update a file
DELETE	`/Files/{FileId}`	Deletes a specific file
GET	`/Files/{FileId}/Associations`	Retrieves a specific file associations
POST	`/Files/{FileId}/Associations`	Creates a new file association
DELETE	`/Files/{FileId}/Associations/{ObjectId}`	Deletes an existing file association
GET	`/Files/{FileId}/Content`	Retrieves the content of a specific file
GET	`/Folders`	Retrieves folders
POST	`/Folders`	Creates a new folder
GET	`/Folders/{FolderId}`	Retrieves specific folder by using a unique folder ID
PUT	`/Folders/{FolderId}`	Updates an existing folder
DELETE	`/Folders/{FolderId}`	Deletes a folder
GET	`/Inbox`	Retrieves inbox folder