---
title: "List file systems"
method: GET
path: "/v2/file-systems"
tags: ["File Systems"]
---

# List file systems

`GET /v2/file-systems`

Retrieves a paginated list of file systems in the workspace. Use cursor-based pagination parameters to navigate through the results.

## Query parameters

- `limit` integer
- `starting_after` string
- `ending_before` string
- `search` string
- `project_id` string

## Response `200`

Successfully retrieved the list of file systems.

- ListFileSystemsResponse
  - `object` 'list', required
  - `data` FileSystem[], required
    - `id` string — The unique identifier of the file system
    - `key` string, required — The unique key of the file system. The key is unique and immutable and cannot be repeated within the same workspace.
    - `display_name` string, required — Human readable name shown in the UI
    - `description` string, required — The description of the file system. Be as precise as possible to help the AI understand what the file system is for.
    - `project_id` string, required — Identifier of the project the file system belongs to
    - `external_access` 'disabled' | 'read_only' | 'read_write', required
    - `created_by_id` string, nullable — The user ID of the creator
    - `updated_by_id` string, nullable — The user ID of the last updater
    - `created` string, required — The creation date of the file system
    - `updated` string, required — The last update date of the file system
    - `sharing` Sharing — Sharing controls which projects in the workspace may use this entity and what they may do with it.
      - `all_projects` SharingAllProjects
      - `selected` SharingSelectedProjects
        - `project_ids` string[] — Projects allowed to use the entity. An empty list shares it with no project.
      - `allow_version_pin` boolean — Consuming projects may pin a specific version instead of tracking latest. Enforcement lives with the consuming reference.
      - `allow_fork` boolean — Projects may duplicate this entity into a detached project-owned copy.
      - `auto_grant_new_projects` boolean — New projects created after this sharing config is applied should receive access automatically. Enforcement lives with project creation and entity-specific adoption code.
    - `used_bytes` string, nullable — Apparent size of the file system in bytes at the last metering. Absent until first metered.
    - `used_inodes` string, nullable — Number of files and directories in the file system at the last metering. Absent until first metered.
    - `last_metered_at` string, nullable — When usage was last measured. Absent until first metered.
  - `has_more` boolean, required

## Other responses

- `401` — Unauthorized - Bearer token is missing or invalid.

## Changes

> 271 revisions in range; 82 not diffed.

- **2026-09-01** `359a7831a2f0` — 1 info
  - endpoint added
- **2026-09-01** `66b8a4902911` — 1 breaking
  - api path removed without deprecation
- **2026-09-01** `081200e02fe0` — 1 info
  - endpoint added
- **2026-08-31** `b22330eb2d5a` — 1 breaking
  - api path removed without deprecation
- **2026-08-31** `3a2f6c296c09` — 1 info
  - endpoint added

[Full history](https://skmtc.dev/orq-ai/apis/orq-ai-api/changes/v2/file-systems/get.md)

---

[API](https://skmtc.dev/orq-ai/apis/orq-ai-api.md) · [All operations](https://skmtc.dev/orq-ai/apis/orq-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/orq-ai/orq-ai-api/revisions/3df7b466d7e5/schema)