Folders

Create a folder

Workspaces API

Preview

Creates a new folder in the workspace. The folder needs to have a name and exclusively define either a parent_folder_id or a parent_folder_path.

Preview API

This API functionality is currently in preview. Preview APIs may be unstable within the preview period: they may change without notice. You must set the header API-Preview: opt-in to opt into using this functionality.

Parameters

authorizationstring

Required

Set to "opt-in" to be able to use this API.

Set to "opt-in" to be able to use this API. This header is being deprecated. Please use the API-Preview header.

org_iduuid

Required

workspace_iduuid

Required

The name of the folder

The ID of the parent folder

The path of the parent folder

{
  "name": "string",
  "parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "parent_folder_path": "string"
}

Returns

201

Folder created successfully.

created_atdate-time

emailstring | null

iduuid

namestring | null

deletedboolean

folder_iduuid

namestring

parent_folder_iduuid | null

pathpath

updated_atdate-time

emailstring | null

iduuid

namestring | null

workspace_iduuid

Endpoint

POST

/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders

Request

curl -X POST 'https://{service_host}/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "created_at": "2024-07-29T15:51:28.071Z",
  "created_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "deleted": true,
  "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "path": "string",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "updated_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Get folder by path.

Workspaces API

Version: 1.0

Preview

Get a folder at the provided path. Optionally include the child folders up to a specified depth.

Preview API

Parameters

authorizationstring

Required

Set to "opt-in" to be able to use this API.

Set to "opt-in" to be able to use this API. This header is being deprecated. Please use the API-Preview header.

org_iduuid

Required

workspace_iduuid

Required

Default: 5000

Max number of results per page.

Number of results to skip before returning limit number of results.

Only show folders that have been deleted.

Max depth of the folder tree to return with the folder.

Examples: "folder_name", "eq:folder_name", "like:folder_name", "ilike:folder_name"

Only show folders with a matching name. This filter supports the operators eq, like, and ilike. If no operator is provided, the eq operator is used. The eq operator performs an exact string match while the like and ilike operators support pattern matching (regular expressions). The only difference between like and ilike is that ilike searches case-insensitive. For example, you can use like:a to find any folder that contain the lower case 'a' or ilike:a to find any folder containing the letter 'A' or 'a'.

Only show folders created by user

Examples: "2023-10-01T00:00:00", "gt:2023-10-01T00:00:00Z", "2023-10-01T00:00:00+12:00"

Only show folders relative to the creation date. This filter supports operators like gt, lt, gte, and lte. For example, you can use 2023-10-01T00:00:000 for exact match or gt:2023-10-01 for greater than. Supported formats are ISO 8601 date strings.

Only show folders modified by user

Examples: "2023-10-01T00:00:00", "gt:2023-10-01T00:00:00Z", "2023-10-01T00:00:00+12:00"

A comma separated list of fields to order by, where the default sort order is ascending. To specify the sort order, prefix the field name with either asc: or desc: for ascending or descending respectively. Field names can be one of the following known sort fields: created_at, updated_at, name

Returns

200

Successful Response

countinteger

created_atdate-time

emailstring | null

iduuid

namestring | null

deletedboolean

folder_iduuid

namestring

parent_folder_iduuid | null

pathpath

updated_atdate-time

emailstring | null

iduuid

namestring | null

workspace_iduuid

limitinteger

offsetinteger

totalinteger

created_atdate-time

emailstring | null

iduuid

namestring | null

deletedboolean

folder_iduuid

namestring

parent_folder_iduuid | null

pathpath

updated_atdate-time

emailstring | null

iduuid

namestring | null

workspace_iduuid

Endpoint

GET

/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/path/*

Request

curl -X GET 'https://{service_host}/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/path/*' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "child_folders": {
    "count": 0,
    "folders": [
      {
        "created_at": "2024-07-29T15:51:28.071Z",
        "created_by": {
          "email": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "deleted": true,
        "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "path": "string",
        "updated_at": "2024-07-29T15:51:28.071Z",
        "updated_by": {
          "email": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "folder": {
    "created_at": "2024-07-29T15:51:28.071Z",
    "created_by": {
      "email": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    },
    "deleted": true,
    "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "path": "string",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "updated_by": {
      "email": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    },
    "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Ensure the existence of all folders in a path

Workspaces API

Version: 1.0

Preview

Ensures that all folders in the specified path exist. If a folder does not exist, it will be created.

Preview API

Parameters

authorizationstring

Required

Set to "opt-in" to be able to use this API.

Set to "opt-in" to be able to use this API. This header is being deprecated. Please use the API-Preview header.

org_iduuid

Required

workspace_iduuid

Required

Returns

200

created_atdate-time

emailstring | null

iduuid

namestring | null

deletedboolean

folder_iduuid

namestring

parent_folder_iduuid | null

pathpath

updated_atdate-time

emailstring | null

iduuid

namestring | null

workspace_iduuid

Endpoint

POST

/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/path/*

Request

curl -X POST 'https://{service_host}/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/path/*' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "folders": [
    {
      "created_at": "2024-07-29T15:51:28.071Z",
      "created_by": {
        "email": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "deleted": true,
      "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "path": "string",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "updated_by": {
        "email": "string",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string"
      },
      "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ]
}

Delete a folder

Workspaces API

Version: 1.0

Preview

Deletes the folder with the given ID. This is not a permanent delete, folder can be restored.

Preview API

Parameters

authorizationstring

Required

Set to "opt-in" to be able to use this API.

Set to "opt-in" to be able to use this API. This header is being deprecated. Please use the API-Preview header.

org_iduuid

Required

folder_iduuid

Required

workspace_iduuid

Required

Returns

204

Successful Response

Endpoint

DELETE

/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/{folder_id}

Request

curl -X DELETE 'https://{service_host}/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/{folder_id}' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

No response body.

Get folder by ID

Workspaces API

Version: 1.0

Preview

Returns a folder by its ID. Optionally include its child folders up to a specified depth.

Preview API

Parameters

authorizationstring

Required

Set to "opt-in" to be able to use this API.

Set to "opt-in" to be able to use this API. This header is being deprecated. Please use the API-Preview header.

org_iduuid

Required

workspace_iduuid

Required

folder_iduuid

Required

Default: 5000

Max number of results per page.

Number of results to skip before returning limit number of results.

Only show folders that have been deleted.

Max depth of the folder tree to return with the folder.

Examples: "folder_name", "eq:folder_name", "like:folder_name", "ilike:folder_name"

Only show folders created by user

Examples: "2023-10-01T00:00:00", "gt:2023-10-01T00:00:00Z", "2023-10-01T00:00:00+12:00"

Only show folders modified by user

Examples: "2023-10-01T00:00:00", "gt:2023-10-01T00:00:00Z", "2023-10-01T00:00:00+12:00"

Returns

200

Successful Response

countinteger

created_atdate-time

emailstring | null

iduuid

namestring | null

deletedboolean

folder_iduuid

namestring

parent_folder_iduuid | null

pathpath

updated_atdate-time

emailstring | null

iduuid

namestring | null

workspace_iduuid

limitinteger

offsetinteger

totalinteger

created_atdate-time

emailstring | null

iduuid

namestring | null

deletedboolean

folder_iduuid

namestring

parent_folder_iduuid | null

pathpath

updated_atdate-time

emailstring | null

iduuid

namestring | null

workspace_iduuid

Endpoint

GET

/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/{folder_id}

Request

curl -X GET 'https://{service_host}/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/{folder_id}' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "child_folders": {
    "count": 0,
    "folders": [
      {
        "created_at": "2024-07-29T15:51:28.071Z",
        "created_by": {
          "email": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "deleted": true,
        "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "path": "string",
        "updated_at": "2024-07-29T15:51:28.071Z",
        "updated_by": {
          "email": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    ],
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "folder": {
    "created_at": "2024-07-29T15:51:28.071Z",
    "created_by": {
      "email": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    },
    "deleted": true,
    "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "path": "string",
    "updated_at": "2024-07-29T15:51:28.071Z",
    "updated_by": {
      "email": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string"
    },
    "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  }
}

Move a folder

Workspaces API

Version: 1.0

Preview

Moves a folder to a new location.

Preview API

Parameters

authorizationstring

Required

Set to "opt-in" to be able to use this API.

Set to "opt-in" to be able to use this API. This header is being deprecated. Please use the API-Preview header.

org_iduuid

Required

folder_iduuid

Required

workspace_iduuid

Required

The ID of the new parent folder

{
  "parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Returns

200

Successful Response

created_atdate-time

emailstring | null

iduuid

namestring | null

deletedboolean

folder_iduuid

namestring

parent_folder_iduuid | null

pathpath

updated_atdate-time

emailstring | null

iduuid

namestring | null

workspace_iduuid

Endpoint

PATCH

/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/{folder_id}

Request

curl -X PATCH 'https://{service_host}/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/{folder_id}' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "created_at": "2024-07-29T15:51:28.071Z",
  "created_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "deleted": true,
  "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "path": "string",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "updated_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Update a folder

Workspaces API

Version: 1.0

Preview

Updates a folders name.

Preview API

Parameters

authorizationstring

Required

Set to "opt-in" to be able to use this API.

Set to "opt-in" to be able to use this API. This header is being deprecated. Please use the API-Preview header.

org_iduuid

Required

folder_iduuid

Required

workspace_iduuid

Required

deletedboolean | null

The new name of the folder

{
  "name": "string"
}

Returns

200

Successful Response

created_atdate-time

emailstring | null

iduuid

namestring | null

deletedboolean

folder_iduuid

namestring

parent_folder_iduuid | null

pathpath

updated_atdate-time

emailstring | null

iduuid

namestring | null

workspace_iduuid

Endpoint

POST

/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/{folder_id}

Request

curl -X POST 'https://{service_host}/workspace/orgs/{org_id}/workspaces/{workspace_id}/folders/{folder_id}' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "created_at": "2024-07-29T15:51:28.071Z",
  "created_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "deleted": true,
  "folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "parent_folder_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "path": "string",
  "updated_at": "2024-07-29T15:51:28.071Z",
  "updated_by": {
    "email": "string",
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string"
  },
  "workspace_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Create a folder​

Parameters

Request headers

Request headers

API-Previewstring | null

Preview-APIstring | null

Path parameters

Path parameters

Body parameters Required

Body parameters Required

namestringRequired(1, 100) chars

parent_folder_iduuid | null

parent_folder_pathpath | null

Example body

Example body

Returns

201

Schema

created_byUserModel

updated_byUserModel

Endpoint

Request

Response

Get folder by path.​

Parameters

Request headers

Request headers

API-Previewstring | null

Preview-APIstring | null

Path parameters

Path parameters

Query parameters

Query parameters

limitinteger

offsetinteger

deletedboolean

max_depthinteger

folder_namestring | null<= 116 chars

created_bystring[] | null

created_atstring | null<= 36 chars

updated_bystring[] | null

updated_atstring | null<= 36 chars

order_bystring(1, 128) chars

Returns

200

Schema

child_foldersChildFolderListResponse

foldersFolderResponse[]

created_byUserModelOptional

updated_byUserModelOptional

folderFolderResponse

created_byUserModel

updated_byUserModel

Endpoint

Request

Response

Ensure the existence of all folders in a path​

Parameters

Request headers

Request headers

API-Previewstring | null

Preview-APIstring | null

Path parameters

Path parameters

Returns

200

Schema

foldersFolderResponse[]

created_byUserModelOptional

updated_byUserModelOptional

Endpoint

Request

Response

Delete a folder​

Parameters

Request headers

Request headers

API-Previewstring | null

Preview-APIstring | null

Path parameters

Create a folder

Body parameters
Required

Get folder by path.

Ensure the existence of all folders in a path

Delete a folder

Get folder by ID

Move a folder

Body parameters
Required

Update a folder