Developer APIResources

Folders

Use the following endpoints to manage folders and projects (top level folders) in your workspace.

ENDPOINT ACCESS

To access these endpoints, your API client must have the appropriate privileges. This is determined by the API client.

You can enable access to these endpoints by editing an existing API client role, or by creating a new API client role:

1

Navigate to Workspace admin > API clients > Client roles.

Select the role you plan to edit.

Alternatively, click + Add client role to create a new API client role.

2

Select Projects and navigate to Project assets > Projects & folders.

3

Select the checkbox(es) next to the endpoint(s) you plan to enable for this role. The following options are available:

  • Projects & folders
    • Select this option to enable all endpoints for this role.
  • List folders GET /api/folders
  • List projects GET /api/projects
  • Create folder POST /api/folders
  • Delete folder DELETE /api/folders/:id
  • Delete project DELETE /api/projects/:id

Select the endpoints you plan to enable

Select the endpoints you plan to enable

Quick reference

TypeResourceDescription
GET/api/foldersList folders.
POST/api/foldersCreate a folder or project.
DELETE/api/folders/:folder_idDelete a folder
PUT/api/folders/:idUpdate a folder.
GET/api/projectsList projects in your workspace.
PUT/api/projects/:idUpdate a project in your workspace.
DELETE/api/projects/:project_idDelete a project in your workspace.