---
title: "List projects"
method: GET
path: "/v1/projects"
tags: ["Projects"]
---

# List projects

`GET /v1/projects`

## Request

- Base URL: `http://localhost:9998`
- URL: `http://localhost:9998/v1/projects`
- Auth: HTTP bearer

Every readable project, the default project (`general`) first, plus each project file
that could not be read, set aside and reported rather than failing the listing.
Mirrors `project_list`.

## Response `200`

The projects and the unreadable files

- WireProjectListResponse
  - `projects` WireProject[], required
    - `id` string, required
    - `name` string, required
    - `instructions` string, required: Applied to every turn of every chat in the project. Empty for none.
    - `settings` WireProjectSettings, required
      - `defaultEndpointConfigId` string: The endpoint configuration the project's chats use unless a turn names another. Absent: the app default.
      - `folders` string[], required: Absolute paths of the folders every chat in the project reads without asking.
      - `pendingFolders` string[]: Folders an agent or another tool asked to add, waiting for the person to allow them.
    - `materials` WireProjectMaterial[], required: The project's knowledge, indexed into the RAG collection it owns.
      - `path` string, required: Absolute path of the file or folder.
      - `addedAt` string, required
    - `pendingMaterials` string[]: Files and folders an agent or another tool asked to add, waiting for the person to allow them.
    - `revision` integer, required: Write counter, 1 at creation, advanced by every change; compared with `expectedRevision`.
    - `createdAt` string, required
    - `updatedAt` string, required
  - `unreadable` WireStoreUnreadableRecord[], required
    - `path` string, required: The file's path under the project store.
    - `reason` string, required

---

[API](https://skmtc.dev/modelpiper/apis/toolpiper-api.md) · [All operations](https://skmtc.dev/modelpiper/apis/toolpiper-api/llms.txt) · [OpenAPI document](https://skmtc.dev/modelpiper/apis/toolpiper-api/revisions/6722bf56385c?raw)