---
title: "List files"
method: GET
path: "/files"
tags: ["files"]
---

# List files

`GET /files`

## Request

- Base URL: `https://{tenant_name}.benchling.com/api/v2`
- URL: `https://{tenant_name}.benchling.com/api/v2/files`
- Auth: HTTP bearer

List files

## Query parameters

- `pageSize` integer
- `nextToken` string
- `sort` 'modifiedAt' | 'name' | 'createdAt' | 'modifiedAt:asc' | 'name:asc' | 'createdAt:asc' | 'modifiedAt:desc' | 'name:desc' | 'createdAt:desc'
- `archiveReason` string
- `createdAt` string
- `creatorIds` string
- `folderId` string
- `mentionedIn` string
- `modifiedAt` string
- `name` string
- `nameIncludes` string
- `names.anyOf.caseSensitive` string
- `names.anyOf` string
- `originIds` string
- `ids` string
- `displayIds` string
- `returning` string

## Response `200`

OK

- FilesPaginatedList
  - `files` File[]
    - `errorMessage` string, nullable
    - `uploadStatus` 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED_VALIDATION' | 'NOT_UPLOADED'
    - `archiveRecord` ArchiveRecord
      - `reason` string
    - `createdAt` string, date-time: Date and time the file was created
    - `creator` FileCreator: UserSummary of the user who created the file
      - `handle` string
      - `id` string
      - `name` string
    - `customFields` CustomFields
    - `displayId` string: User-friendly ID of the file
    - `filename` string
    - `folderId` string: ID of the folder that contains the file
    - `id` string
    - `modifiedAt` string, date-time: Date and time the file was last modified
    - `name` string
  - `nextToken` string

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/benchling/apis/benchling-api-2.md) - [All operations](https://skmtc.dev/benchling/apis/benchling-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/benchling/apis/benchling-api-2/revisions/01d2fa8523cd?raw)