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

Get a folder

Retrieves a single folder from a video workspace. Use the workspace and folder IDs to fetch the folder's details, including its parent, path, and asset counts.

2 parameters
workspace_idstringrequired

The ID of the video workspace containing the folder.

folder_idstringrequired

The ID of the folder to retrieve.

5 status codes
200Returns the folder object, including its ID, name, workspace, parent, path, asset count, and timestamps.
asset_countintegeroptional

Number of assets in this folder

Default:0
created_atstringoptional

Folder creation time in ISO 8601 format

depthintegeroptional

Depth of this folder from the root

Default:0
idstringoptional

Folder ID

namestringoptional

Folder name

parent_idstringoptional

Parent folder ID

patharray<string>optional

Path for this folder

path_namesarray<string>optional
subdirectory_countintegeroptional

Number of folders inside this folder

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_folder_id

    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
404Returned when the workspace or folder is not found.

One documented failure

  • folder_not_found

    Folder not found.

errorobjectrequired

Error handling

The workspace_id path parameter identifies the workspace, and the folder_id path parameter identifies the folder to retrieve. A 404 is returned when the requested resource is not found; a 400 indicates a bad request, a 401 indicates missing or invalid authentication, and a 403 indicates an unpaid account or insufficient role permissions.