Workspaces API

Version: 1.0

Preview

Get folder by ID

GET

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

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.

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

Request

Path parameters

workspace_iduuid

Required

folder_iduuid

Required

org_iduuid

Required

Query parameters

limitinteger

Default: 5000

Max number of results per page.

offsetinteger

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

deletedboolean

Only show folders that have been deleted.

max_depthinteger

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

folder_namestring | null

<= 116 chars

created_byuuid | null

created_atstring | null

<= 36 chars

updated_byuuid | null

updated_atstring | null

<= 36 chars

Responses

200

Successful Response

Response schema

child_foldersChildFolderListResponse

countinteger

foldersobject[]

created_atdate-time

created_byUserModel

Optional

emailstring | null

iduuid

namestring | null

deletedboolean

folder_iduuid

namestring

parent_folder_iduuid | null

pathpath

updated_atdate-time

updated_byUserModel

Optional

emailstring | null

iduuid

namestring | null

workspace_iduuid

limitinteger

Default: 5000

offsetinteger

totalinteger

folderFolderResponse

created_atdate-time

created_byUserModel

emailstring | null

iduuid

namestring | null

deletedboolean

folder_iduuid

namestring

parent_folder_iduuid | null

pathpath

updated_atdate-time

updated_byUserModel

emailstring | null

iduuid

namestring | null

workspace_iduuid

Example 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": 5000,
    "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"
  }
}

401

No permission -- see authorization schemes

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

403

Request forbidden -- authorization will not help

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

404

Resource not found or user lacks access

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

405

Specified method is invalid for this resource

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

410

Resource is gone

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

422

Unprocessable Content

Response schema

detailstring | null

invalid-paramsobject[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}