Embedded APIResources

Folders

Use the following endpoint to manage folders and projects (top level folders) in customer workspaces.

ENDPOINT ACCESS

To access these endpoints, your API client must have the appropriate privileges. This is determined by the role assigned to your 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

Navigate to Customer workspaces > Projects > 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/managed_users/:managed_user_id/folders
  • List projects GET /api/managed_users/:managed_user_id/projects
  • Create folder POST /api/managed_users/:managed_user_id/folders
  • Delete folder DELETE /api/managed_users/:managed_user_id/folders
    /:folder_id
  • Delete project DELETE /api/managed_users/:managed_user_id/projects
    /:project_id

Select the endpoints you plan to enable

Select the endpoints you plan to enable

Quick reference

TypeResourceDescription
GET/api/managed_users/:managed_user_id/foldersList folders in a customer workspace.
POST/api/managed_users/:managed_user_id/foldersCreate a folder in a customer workspace.
PUT/api/managed_users/:managed_user_id/folders/:folder_idUpdate a folder in a customer workspace.
DELETE/api/managed_users/:managed_user_id/folders/:folder_idDelete a folder in a customer workspace.