Get all files

GET

files

Get all files

curl --request GET \
  --url https://api.orion.file.ai/prod/v1/files \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.orion.file.ai/prod/v1/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "files": [
    {
      "fileId": "53d6a0b1-2a8d-4ed9-9e6a-ceaef7ca3908",
      "fileName": "file1.jpg",
      "fileType": "image/jpeg",
      "fileSize": 261928,
      "fileStoragePath": "path/to/file1.jpg",
      "fileHash": "be3ef5fbb21e31c1281300b23b1c918a8ba54427c799aea21865f68d5efd01b7",
      "uploadId": "f2538513-f0b9-4aa8-9c57-bc0a85c77de6",
      "status": "processed",
      "currency": "USD",
      "summary": "Example file",
      "referenceId": "1e70a5e860",
      "isDuplicate": false,
      "isEmbedded": false,
      "schemaId": "6835aca6030a79ffaabca742",
      "fileClass": "Receipt",
      "fileContactId": "6835aca2281d9ed1bab90b11",
      "fileContactName": "Example Company",
      "createdAt": "2025-05-27T12:14:24.258Z",
      "updatedAt": "2025-05-27T12:14:24.258Z",
      "directoryIds": [
        "6a0d8fa8e00fd1d2a80c6aa7",
        "6a0d8fa8e00fd1d2a80c6ab1"
      ],
      "exportInfo": {
        "integrationExportStatus": "completed",
        "integrationExportMessages": [
          "System successfully received result"
        ],
        "integrationExportUpdatedAt": "2025-05-27T14:30:00.000Z"
      }
    }
  ],
  "count": 1,
  "currentPage": 1
}

Request · Guide: Extract fields

More details

This endpoint is paginated. Use the page and limit query parameters to control pagination.Alternatively, pass the cursor query parameter (empty for the first page) to use cursor pagination: the response envelope becomes { data, pagination: { limit, nextCursor, hasMore } } and pages are stable under concurrent writes. Follow nextCursor until hasMore is false; keep the same sort and filter parameters for every page of a walk.Use the optional updatedAfter query parameter to filter files that have been updated on or after the specified timestamp (ISO 8601 format). Use the optional createdAfter query parameter to filter files that have been created on or after the specified timestamp (ISO 8601 format). These filters are useful for batch processes that need to fetch only files modified or created since the last sync.Use the optional directoryId query parameter to return only files that belong to the specified directory (or sub-directory). Files in nested descendants are not included; pass the sub-directory id directly to fetch its files.fileName reflects the file’s current display name: if the file has been renamed, this is the renamed name (with its original extension); otherwise it is the originally uploaded filename.

Authorizations

x-api-key

string

header

required

API key for authentication

Query Parameters

fileIds

string

File Ids

Example:

"649e2d2d2d2d2d2d2d2d2d2d"

updatedAfter

string

Filter files updated on or after this timestamp (ISO 8601 format)

Example:

"2025-01-01T00:00:00.000Z"

createdAfter

string

Filter files created on or after this timestamp (ISO 8601 format)

Example:

"2025-01-01T00:00:00.000Z"

directoryId

string

Filter files that belong to the given directory (or sub-directory) id. Only files directly linked to this directory are returned; descendants are not included.

Example:

"649e2d2d2d2d2d2d2d2d2d2d"

page

number

default:1

Page number

Example:

1

limit

number

default:100

Number of items per page

Example:

100

sortBy

string

default:createdAt

Field to sort by

Example:

"createdAt"

sortOrder

enum<string>

default:ASC

Sort direction

Available options:

ASC,

DESC

Example:

"ASC"

cursor

string

Opaque pagination cursor. Provide the parameter (empty value for the first page) to switch to cursor pagination: the response becomes { data, pagination: { limit, nextCursor, hasMore } } with default limit 50 (max 100). Omit it entirely for legacy page/limit pagination. In cursor mode sortBy must be one of createdAt, updatedAt, _id, and cursors are bound to the sortBy/sortOrder they were minted with.

Response

The list of files is found. Offset mode (default) returns {files, count, currentPage}; cursor mode (when the cursor query parameter is present) returns {data, pagination}.

Option 1
Option 2

files

object[]

required

count

number

required

Total number of matching files

currentPage

number

required

Get all files

curl --request GET \
  --url https://api.orion.file.ai/prod/v1/files \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.orion.file.ai/prod/v1/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "files": [
    {
      "fileId": "53d6a0b1-2a8d-4ed9-9e6a-ceaef7ca3908",
      "fileName": "file1.jpg",
      "fileType": "image/jpeg",
      "fileSize": 261928,
      "fileStoragePath": "path/to/file1.jpg",
      "fileHash": "be3ef5fbb21e31c1281300b23b1c918a8ba54427c799aea21865f68d5efd01b7",
      "uploadId": "f2538513-f0b9-4aa8-9c57-bc0a85c77de6",
      "status": "processed",
      "currency": "USD",
      "summary": "Example file",
      "referenceId": "1e70a5e860",
      "isDuplicate": false,
      "isEmbedded": false,
      "schemaId": "6835aca6030a79ffaabca742",
      "fileClass": "Receipt",
      "fileContactId": "6835aca2281d9ed1bab90b11",
      "fileContactName": "Example Company",
      "createdAt": "2025-05-27T12:14:24.258Z",
      "updatedAt": "2025-05-27T12:14:24.258Z",
      "directoryIds": [
        "6a0d8fa8e00fd1d2a80c6aa7",
        "6a0d8fa8e00fd1d2a80c6ab1"
      ],
      "exportInfo": {
        "integrationExportStatus": "completed",
        "integrationExportMessages": [
          "System successfully received result"
        ],
        "integrationExportUpdatedAt": "2025-05-27T14:30:00.000Z"
      }
    }
  ],
  "count": 1,
  "currentPage": 1
}

Get started

Endpoints

Authorizations

Query Parameters

Response