XExeroapi
Files

Retrieves specific folder by using a unique folder ID

Changed on

By passing in the appropriate ID, you can search for specific folder

get/Folders/{FolderId}

Request

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

Path parameters

FolderIdstring uuid required
Example:4ff1e5cc-9835-40d5-bb18-09fdb118db9c

Folder id for single object

Response

search results matching criteria

Namestring

The name of the folder

FileCountinteger

The number of files in the folder

Emailstring

The email address used to email files to the inbox. Only the inbox will have this element.

IsInboxboolean

to indicate if the folder is the Inbox. The Inbox cannot be renamed or deleted.

Idstring uuid

Xero unique identifier for a folder Files

Example response

{
  "Name": "assets",
  "FileCount": 5,
  "Email": "foo@bar.com",
  "IsInbox": true,
  "Id": "4ff1e5cc-9835-40d5-bb18-09fdb118db9c"
}

Changes