Beta
Files

List Files

Changed on

List files with optional filtering and pagination.

Filter by file_name, file_ids, or external_file_id. Supports cursor-based pagination and custom ordering.

get/api/v1/beta/files

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

page_sizeinteger nullable

The maximum number of items to return. Defaults to 50, maximum is 1000.

page_tokenstring nullable

A page token received from a previous list call. Provide this to retrieve the subsequent page.

file_idsstring[] nullable

Filter by specific file IDs.

file_namestring nullable

Filter by file name (exact match).

external_file_idstring nullable

Filter by external file ID.

order_bystring nullable

A comma-separated list of fields to order by, sorted in ascending order. Use 'field_name desc' to specify descending order.

expandstring[] nullable

Fields to expand on each file.

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

next_page_tokenstring nullable

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_sizeinteger nullable

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Example response

{
  "items": [
    {
      "id": "dfl-aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "name": "invoice.pdf",
      "external_file_id": "ext-12345",
      "file_type": "pdf",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "purpose": "parse"
    }
  ]
}

Changes

  • b17341164de9Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 34da5826db1cRevision changes
    • info

      added the new optional query request parameter expand

    • info

      added the optional property // to the response with the status