List Files | extend

import { ExtendClient } from "extend-ai";
const client = new ExtendClient({ token: "YOUR_TOKEN" });
await client.files.list({
    nextPageToken: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
});

{
  "success": true,
  "files": [
    {
      "object": "file",
      "id": "file_xK9mLPqRtN3vS8wF5hB2cQ",
      "name": "Invoices.pdf",
      "metadata": {
        "pageCount": 30,
        "parentSplit": {
          "id": "string",
          "type": "Invoice",
          "identifier": "other_2_9",
          "startPage": 1,
          "endPage": 10
        }
      },
      "createdAt": "2024-03-21T15:30:00Z",
      "updatedAt": "2024-03-21T16:45:00Z",
      "type": "PDF",
      "presignedUrl": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
      "parentFileId": "file_Zk9mNP12Qw4yTv8BdR3H",
      "contents": {
        "rawText": "string",
        "markdown": "string",
        "pages": [
          {
            "pageNumber": 1,
            "pageHeight": 10,
            "pageWidth": 10,
            "rawText": "This is the raw text of the page.",
            "markdown": "# Heading\n\nThis is a paragraph with **bold** and *italic* text.\n\n- List item 1\n- List item 2\n\n> This is a blockquote",
            "html": "<div>This is the html of the page.</div>"
          }
        ],
        "sheets": [
          {
            "sheetName": "Sheet1",
            "rawText": "This is the raw text of the sheet."
          }
        ]
      },
      "usage": {
        "credits": 10
      }
    }
  ],
  "nextPageToken": "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="
}

List files in your account. Files represent documents that have been uploaded to Extend. This endpoint returns a paginated response. You can use the nextPageToken to fetch subsequent results.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

x-extend-workspace-idstringOptional

The workspace ID to target. Required when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See Authentication for details on API key scopes.

The workspace ID to target. **Required** when using an organization-scoped API key; optional for workspace-scoped keys (the key is already tied to a workspace). See [Authentication](https://docs.extend.ai/2025-04-21/developers/authentication) for details on API key scopes.

Query parameters

nameContainsstringOptional

Filters files to only include those that contain the given string in the name.

Example: "invoice"

sortDirenumOptionalDefaults to desc

Sorts the files in ascending or descending order. Ascending order means the earliest file is returned first.

Allowed values:

nextPageTokenstringOptional

The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a nextPageToken in the response if there are more results.

Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.

example: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="

The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a `nextPageToken` in the response if there are more results. Note that if other parameters are changed in subsequent requests, you may receive inconsistent data. example: `"xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="`

maxPageSizeintegerOptional1-1000Defaults to 10

The maximum number of results to return in the response. You may receive less than this number if there are fewer results than the maximum.

Response

Successfully retrieved files

successboolean

fileslist of objects

nextPageTokenstring

The token used to fetch the page of results from a previous request. We use cursor based pagination and will return a nextPageToken in the response if there are more results.

Note that if other parameters are changed in subsequent requests, you may receive inconsistent data.

example: "xK9mLPqRtN3vS8wF5hB2cQ==:zWvUxYjM4nKpL7aDgE9HbTcR2mAyX3/Q+CNkfBSw1dZ="

Errors

400

Bad Request Error

401

Unauthorized Error