Get project

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

post/api/v1/get_project

Request

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

Request body

projectstring required

Project name (one of your own) or id (any project you can access).

Response

Success.

idstring required
namestring required
is_defaultboolean required
your_role'owner' | 'editor' | 'commenter' | 'viewer' required

Your role on the document or project.

owner_handlestring required
directoriesSchema0[] required(unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.