---
title: "Get project"
method: POST
path: "/api/v1/get_project"
---

# Get project

`POST /api/v1/get_project`

## Request

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

Read a project's directory tree and the documents in it (paths, no content). Pass a project name (your own) or id (any project you can access).

## Request body

- object
  - `project` string, required: Project name (one of your own) or id (any project you can access).

## Response `200`

Success.

- object
  - `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
  - `root_documents` object[], required
    - `id` string, required
    - `slug` string, required
    - `title` string, required
    - `url` string, required: Absolute URL of the document's page.
    - `visibility` 'public' | 'private', required
    - `revision` integer, required
    - `updated_at` string, required: ISO 8601 timestamp.
  - `directories` Schema0[], required (unresolved $ref)

## 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)