---
title: "List projects"
method: POST
path: "/api/v1/list_projects"
---

# List projects

`POST /api/v1/list_projects`

## Request

- Base URL: `https://offprint.io`
- URL: `https://offprint.io/api/v1/list_projects`
- Auth: HTTP bearer

List the projects you can access — your own (Default first) and projects shared with you. Every document lives in exactly one project; use get_project for a project's directory tree and contents.

## Request body

- object

## Response `200`

Success.

- object
  - `projects` object[], required
    - `id` string, required
    - `name` string, required
    - `is_default` boolean, required
    - `your_role` 'owner' | 'editor' | 'commenter' | 'viewer', required: Your role on the document or project.
    - `owner_handle` string, required
    - `doc_count` integer, required

## Other responses

- `400`: Invalid arguments.
- `401`: Missing, expired or revoked API key.
- `403`: The key's scope, restriction or role does not allow this.
- `404`: Not found, or outside the key's restriction.
- `409`: The document changed since expected_revision.
- `429`: A plan limit or daily quota was reached.

---

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