---
title: List Files
url: https://platform.claude.com/docs/en/api/typescript/files/list
---

# List Files

`client.files.list(params?, options?): PageCursor<FileMetadata>`

**GET** `/v1/files`

List Files

## Parameters

- `params: FileListParams`

  - `ids?: Array<string> | null` (query parameter)

    Restrict the result set to Files whose `id` is in this list. At most 100 entries (after de-duplication). Mutually exclusive with `page` and `limit`. When supplied, the response is always a single page (`next_page` is null). IDs that do not resolve to a visible File — including deleted Files — are silently omitted.

  - `limit?: number` (query parameter)

    Number of items to return per page.

    Defaults to `20`. Ranges from `1` to `1000`.

    minimum: 1, maximum: 1000

  - `page?: string | null` (query parameter)

    Opaque page cursor returned in a prior list response's `next_page`. Prefixed `page_`.

  - `workspace_id?: string` (header parameter)

    Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).

    Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace.

## Returns

- `interface FileMetadata`

  - `type: "file"`

    Object type.

    For files, this is always `"file"`.

  - `id: string`

    Unique object identifier.

    The format and length of IDs may change over time.

  - `created_at: string`

    RFC 3339 datetime string representing when the file was created.

    format: date-time

  - `filename: string`

    Original filename of the uploaded file.

    minLength: 1, maxLength: 500

  - `mime_type: string`

    MIME type of the file.

    minLength: 1, maxLength: 255

  - `size_bytes: number`

    Size of the file in bytes.

    minimum: 0

  - `downloadable?: boolean`

    Whether the file can be downloaded.

    default: false

  - `expires_at?: string | null`

    RFC 3339 datetime string representing when the file will expire and become unavailable for download. Null if the file does not expire. For files uploaded with `expires_in_seconds`, this is the upload time plus that value.

    format: date-time

## Example

```typescript
import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic({
  apiKey: process.env["ANTHROPIC_API_KEY"] // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const fileMetadata of client.files.list()) {
  console.log(fileMetadata.id);
}
```

### Response (200)

```json
{
  "data": [
    {
      "id": "file_011CNha8iCJcU1wXNR6q4V8w",
      "created_at": "2025-04-15T18:37:24.100435Z",
      "filename": "document.pdf",
      "mime_type": "application/pdf",
      "size_bytes": 102400,
      "type": "file",
      "downloadable": false,
      "expires_at": "2025-05-15T18:37:24.100435Z"
    }
  ],
  "next_page": "next_page"
}
```