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

List assets and folders in a workspace

Lists folders and assets in a video workspace, with optional filters for browsing or searching. Use parent_id to browse a folder or the root level, and filter assets by fields such as title, status, and playlist_id. Use offset and size to paginate the results.

17 parameters
workspace_idstringrequired

The unique identifier of the video workspace to list folders and assets from.

typestringoptional

Choose whether to return folders, videos, or both: folders, videos, or all. Defaults to all when omitted.

Allowed:foldersvideosallDefault:all
parent_idstringoptional

The identifier of the parent folder to browse; send null to browse the workspace root.

titlestringoptional

Search folder or asset titles and descriptions for this text.

statusstringoptional

Comma-separated asset status values to filter by.

tagstringoptional

Comma-separated asset tags to filter by.

playlist_idstringoptional

The identifier of a playlist to filter assets by.

start_datestringoptional

Lower bound for the asset creation date, in yyyy-MM-dd format.

end_datestringoptional

Upper bound for the asset creation date, in yyyy-MM-dd format.

min_durationnumberoptional

Minimum asset duration in seconds.

max_durationnumberoptional

Maximum asset duration in seconds.

sortBystringoptional

Field to sort assets by: title, duration, uploaded_at, or created_at.

Allowed:titledurationuploaded_atcreated_at
orderBystringoptional

Sort direction: asc or desc.

Allowed:ascdesc
searchIndexstringoptional

Search index to use: search_index_for_asset_list, cms-search, or cms-search-v2.

Allowed:search_index_for_asset_listcms-searchcms-search-v2
offsetintegeroptional

Offset for paginated results. Defaults to 0 when omitted.

Default:0
sizeintegeroptional

Number of results per page; maximum 100. Defaults to 20 when omitted.

Default:20
signed_tokenstringoptional

Whether to return pre-signed URLs, as the string true or false. Defaults to false when omitted.

Allowed:truefalseDefault:false

4 status codes
200Returns folders and asset records, along with folder and asset counts, the current offset, and the total count.
all_assetsarray<object>required
asset_countintegeroptional
Default:0
current_offsetintegeroptional
Default:0
folder_countintegeroptional
Default:0
foldersarray<object>optional
total_countintegeroptional
Default:0
400Returned when the request is invalid.

One documented failure

  • page_size_more_than_max

    Value for the page size (size) parameter is more than permissible value (100)

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 for an unpaid account or insufficient role permissions.

One documented failure

  • unauthorized

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

errorobjectrequired

Error handling

A 400 is returned when the request is invalid. A 401 is returned when the API key or bearer token is missing or invalid. A 403 is returned for an unpaid account or insufficient role permissions. The workspace_id path parameter must identify a workspace, size must not exceed 100, and type must be folders, videos, or all when provided.