PRprocess
Folders

List all folders

Changed on

Returns a paginated list of folders in your organization that you have permission to read, sorted by creation date (newest first). Excludes system folders (Home and Private). Without parentFolderId, it returns folders at every level of the tree; use parentFolderId to browse one level at a time.

get/folders

Request

  • Base URL
    https://public-api.process.st/api/v1.1
  • URL
    https://public-api.process.st/api/v1.1/folders
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Query parameters

namestring

Filter by folder name (case-insensitive substring match).

parentFolderIdstring

Filter to the direct subfolders of this folder. A top-level folder's parentFolderId is the organization's Home folder, so pass that ID to list the top-level folders.

_string

Opaque pagination cursor. Take this value from the previous response's links[] entry whose name is "next" (typically just follow that link's href instead of reading this value). Omit on the first page. If the previous response had no next link, there are no more pages.

Response

Example response

{
  "data": [
    {
      "id": "qtFsOkIjKKYBoZxta91x7A",
      "createdBy": {
        "id": "paiZa0_oyxEBoZxtatp33g",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      },
      "updatedBy": {
        "id": "paiZa0_oyxEBoZxtatp33g",
        "email": "jane.doe@example.com",
        "username": "Jane Doe"
      },
      "links": [
        {
          "href": "https://api.process.st/api/v1.1/resource/XXX"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}

Changes

  • 78ea0b3f3b40Revision changes
    • info

      added the new optional query request parameter name

    • info

      added the new optional query request parameter parentFolderId