folders

List folders

The story folders the API key's creator can open - the folder tree they see in the dashboard (an administrator's key sees every folder) - with each folder's path and who can open it, in the same shape as a version's folder. A parent they cannot open is left out of path, and the folder's parentId is then null. Use it to pick a folderId for GET /v2/versions. A key scoped to one story lists only the folder that story is in (none if it sits at the root).

get/v2/folders

Request

  • Base URL
    https://api.storydoc.com
  • Auth
    HTTP bearer

Response

The folders

Example response

{
  "data": [
    {
      "id": "64f1c2a9e1b2c3d4e5f60718",
      "name": "Enterprise",
      "path": [
        "Sales",
        "Enterprise"
      ],
      "members": [
        {
          "name": "Dana Lee",
          "email": "dana@company.com"
        }
      ]
    }
  ]
}

Changes

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