OCT-103 Gumlet outreach
GET/video/workspaces/{workspace_id}/folders

List folders in a video workspace

Lists folders in a video workspace. Use parent_id to limit the results to folders under a specific parent, or send null to list root folders.

2 parameters
workspace_idstringrequired

The ID of the video workspace whose folders to list.

parent_idstringoptional

The parent folder ID to list folders within. Send null to list root folders.

4 status codes
200Returns an array of folder objects, including each folder's ID, name, parent, path, asset count, and timestamps.
asset_countintegeroptional

Number of assets inside this folder

Default:0
created_atstringoptional

Folder creation time in ISO 8601 format

depthintegeroptional

Depth from root folder

Default:0
idstringoptional

Folder ID

namestringoptional

Folder name

parent_idstringoptional

Parent folder ID

patharray<string>optional

Path of the folder

path_namesarray<string>optional
subdirectory_countintegeroptional

Number of child folders

Default:0
updated_atstringoptional

Folder update time in ISO 8601 format

video_source_idstringdeprecatedoptional

Deprecated. Use workspace_id instead. Still returned for backwards compatibility.

workspace_idstringoptional

Workspace ID

400Returned when the request is invalid.

One documented failure

  • invalid_parent_id

    Parent folder ID is invalid.

errorobjectrequired
401Returned when the API key or bearer token is missing or invalid.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user lacks sufficient role permissions.

One documented failure

  • unauthorized

    You don't have access to this feature. Please contact your organization owner.

errorobjectrequired

Error handling

The workspace_id path parameter identifies the workspace whose folders you want to list. A 400 indicates a bad request, a 401 indicates missing or invalid authentication, and a 403 indicates an unpaid account or insufficient role permissions; use parent_id to select a parent folder or null for root folders.