XExeroapi
Files

Retrieves files

Changed on
get/Files

Request

  • Base URL
    https://api.xero.com/files.xro/1.0
  • URL
    https://api.xero.com/files.xro/1.0/Files
  • Auth
    OAuth 2
    Authorization code: https://login.xero.com/identity/connect/authorize
    Token URL: https://identity.xero.com/connect/token scopes: files, files.read

Query parameters

pagesizeinteger
Example:50

pass an optional page size value

pageinteger
Example:2

number of records to skip for pagination

sort'Name' | 'Size' | 'CreatedDateUTC'
Example:CreatedDateUTC

values to sort by

direction'ASC' | 'DESC'
Example:ASC

sort direction

Response

search results matching criteria

TotalCountinteger
Pageinteger
PerPageinteger

Example response

{
  "TotalCount": 2,
  "Page": 1,
  "PerPage": 50,
  "Items": [
    {
      "Name": "File2.jpg",
      "MimeType": "image/jpeg",
      "Size": 3615,
      "CreatedDateUtc": "2020-12-03T19:04:58.6970000",
      "UpdatedDateUtc": "2020-12-03T19:04:58.6970000",
      "User": {
        "Id": "4ff1e5cc-9835-40d5-bb18-09fdb118db9c",
        "Name": "john.smith@mail.com",
        "FirstName": "John",
        "LastName": "Smith",
        "FullName": "Smith"
      },
      "Id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "FolderId": "0f8ccf21-7267-4268-9167-a1e2c40c84c8"
    }
  ]
}

Changes

  • 2448e2eaee64Revision changes
    • info

      added the new optional query request parameter direction

  • bb86098f8245Revision changes
    • breaking

      added the new required header request parameter xero-tenant-id to all path's operations

    • breaking

      the response's body type changed from no type to object for status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status