Xero

Xero Files API

These endpoints are specific to Xero Files API

Finance & banking#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

These endpoints are specific to Xero Files API

Endpoints 18

Files

  • GETRetrieves files/Files?pagesize=50&page=2&sort=CreatedDateUTC&direction=ASC
  • POSTUploads a File to the inbox/Files
  • GETRetrieves a file by a unique file ID/Files/:FileId
  • PUTUpdate a file/Files/:FileIdUpdates file properties of a single file
  • DELETEDeletes a specific file/Files/:FileIdDelete a specific file
  • POSTUploads a File to a specific folder/Files/:FolderId
  • GETRetrieves the content of a specific file/Files/:FileId/ContentBy passing in the appropriate options, retrieve data for specific file
  • GETRetrieves a specific file associations/Files/:FileId/AssociationsBy passing in the appropriate options,
  • POSTCreates a new file association/Files/:FileId/AssociationsBy passing in the appropriate options, you can create a new folder
  • DELETEDeletes an existing file association/Files/:FileId/Associations/:ObjectIdBy passing in the appropriate options, you can create a new folder
  • GETRetrieves an association object using a unique object ID/Associations/:ObjectId?pagesize=50&page=2&sort=Associations/{ObjectId}?sort=CreatedDateUtc&direction=Associations/{ObjectId}?sort=CreatedDateUtc&direction=DESCBy passing in the appropriate options, you can retrieve an association
  • GETRetrieves a count of associations for a list of objects./Associations/Count?ObjectIds=1270bf7c-5d18-473a-9231-1e36c4bd33edBy passing in the appropriate options, you can retrieve the association count for objects
  • GETRetrieves folders/Folders?sort=CreatedDateUTC DESCBy passing in the appropriate options, you can search for available folders
  • POSTCreates a new folder/FoldersBy passing in the appropriate properties, you can create a new folder
  • GETRetrieves specific folder by using a unique folder ID/Folders/:FolderIdBy passing in the appropriate ID, you can search for specific folder
  • PUTUpdates an existing folder/Folders/:FolderIdBy passing in the appropriate ID and properties, you can update a folder
  • DELETEDeletes a folder/Folders/:FolderIdBy passing in the appropriate ID, you can delete a folder
  • GETRetrieves inbox folder/InboxSearch for the user inbox

API details

Base URL
https://api.xero.com/files.xro/1.0
Authentication
OAuth 2.0 (authorization code flow) with 5 scopes
Operations
18 operations on 11 pathsGET 9POST 4DELETE 3PUT 2
Main resources
Files 18
Response formats
application/json application/octet-stream
Description format
OpenAPI 3.0.0, API version 20.1.0

How to test the Xero Files API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Xero Files API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 5 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieves files” (GET /Files?pagesize=50&page=2&sort=CreatedDateUTC&direction=ASC), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Xero Files API?

These endpoints are specific to Xero Files API It is listed under Finance & banking and has 18 endpoints.

Who publishes the Xero Files API?

It is listed from Xero's public API description (an OpenAPI document), not published by Xero on Swastik Codes. Anyone who controls xero.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Xero Files API?

Requests go to https://api.xero.com/files.xro/1.0. Endpoint paths are added to this base URL.

How do I authenticate with the Xero Files API?

With OAuth 2.0 (authorization code flow) with 5 scopes.

How many endpoints does the Xero Files API have?

18 operations on 11 paths (9 GET, 4 POST, 3 DELETE, 2 PUT). The largest groups are Files.

Is forking the Xero Files API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.