PapermarkDocs
APIReferenceFolders

Get a folder

Returns a single folder by id.

GET
/v1/folders/{id}

Authorization

bearerAuth documents.read
AuthorizationBearer <token>

Dashboard-issued token (pm_live_...) or OAuth-issued access token.

In: header

Scope: documents.read

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.papermark.com/v1/folders/string"
{
  "id": "clxy9abc1234567890",
  "name": "Pitches",
  "parent_id": null,
  "path": "/pitches",
  "icon": null,
  "color": null,
  "document_count": 0,
  "child_folder_count": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Missing bearer token.",
    "doc_url": "https://www.papermark.com/docs/api/errors#unauthorized",
    "details": null
  }
}

Create a folder

Create a folder in the team library. The folder's `path` is derived server-side from its name and parent — clients never set it. If a sibling already has the chosen name, a numeric suffix is appended (e.g. `Pitches (1)`).

Update a folder

Rename the folder or update its icon/color. Renaming rewrites the `path` of this folder and every descendant in a single transaction.