---
title: "List a project's sheets in the app's order"
method: GET
path: "/v1/projects/{project_id}/sheets"
tags: ["Projects"]
---

# List a project's sheets in the app's order

`GET /v1/projects/{project_id}/sheets`

## Request

- Base URL: `https://api.kamai.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.kamai.io/v1/projects/{project_id}/sheets`
- Auth: HTTP bearer

Every sheet of the project, in the order and with the names the Kamai app shows, so
an integration can show a sheet list that matches the app and let a user pick a sheet.

The order is the natural order of the sheet names (A-2 before A-10), the same for every
user, computed on each call: it can change when an upload finishes or a sheet is
renamed, so keep each sheet's `blueprint_id` rather than its place. `label` is the name
to show; `display_name`, `sheet_number` and `title` give its parts. Uploads still
processing are not listed until their sheet exists.

403 when the project belongs to another account; 404 when no project has this id.

## Path parameters

- `project_id` string, required

## Response `200`

Successful Response

- ProjectSheetsResponse
  - `project_id` string, required: The project.
  - `sheets` SheetPublic[]: Every sheet of the project in the app's order: the natural order of the names, the same for every user. Uploads still processing are not listed.
    - `blueprint_id` string, required: The sheet's id. Refer to a sheet by it: the list order can change when an upload finishes or a sheet is renamed.
    - `label` string, required: What the Kamai app calls this sheet. Usually equal to display_name; a sheet named only by a meaningless file name reads 'Sheet N · <file name>', and two sheets that would read the same each get a hint: '(p. 3)' is the page of the upload file, '(#4)' the place in this list.
    - `display_name` string, required: The user's own name if they renamed the sheet, else its title block ('A-101 FLOOR PLAN'), else its file name.
    - `sheet_number` string, nullable: The sheet number from the title block, e.g. A-101. Not unique and not an address.
    - `title` string, nullable: The sheet title from the title block.

## Other responses

- `403`: The project belongs to another account.
- `404`: No project has this id.
- `422`: Validation Error

---

[API](https://skmtc.dev/kamai/apis/kamai-api.md) · [All operations](https://skmtc.dev/kamai/apis/kamai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kamai/apis/kamai-api/revisions/78f938546270?raw)