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

List assets in a workspace

Lists assets in a video workspace, with filters for status, tags, title, folder, and playlist. Use type to select folders, videos, or both, and sortBy and orderBy to control asset ordering. This operation is closing down and will be removed on a date not specified in the API definition.

11 parameters
workspace_idstringrequired

The identifier of the video workspace to list assets from.

statusstringoptional

Filter by one asset status or a comma-separated list: queued, processing, ready, errored, or deleted.

Allowed:queuedprocessingreadyerroreddeleted
tagstringoptional

Filter by one tag or a comma-separated list of tags.

titlestringoptional

Filter assets by title.

folderstringoptional

Filter assets by folder name.

offsetstringoptional

Offset for the paginated asset list.

sizestringoptional

Page size, up to 100. Defaults to 10 when omitted.

playlist_idstringoptional

Filter assets to a playlist by its identifier.

sortBystringoptional

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

Allowed:titledurationuploaded_atcreated_atDefault:created_at
orderBystringoptional

Sort direction: asc or desc. Defaults to desc when omitted.

Allowed:ascdescDefault:desc
typestringoptional

Choose whether to search for folders, videos, or both. Defaults to both when omitted.

4 status codes
200Returns asset records, the current offset, the total asset count, and distinct tags.
all_assetsarray<object>optional
current_offsetintegeroptional
Default:0
distinct_tagsarray<string>optional
total_asset_countintegeroptional
Default:0
400Returned when the request is invalid.

One documented failure

  • collection_not_found

    Could not find any video workspace with specified workspace_id.

errorobjectrequired
401Returned when the request is unauthorized.

One documented failure

  • source_not_found

    Could not find any video source with specified source ID.

errorobjectoptional
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 for a bad request. A 401 indicates an unauthorized request. A 403 is returned for an unpaid account or insufficient role permissions. The workspace_id path parameter identifies the workspace, and status accepts queued, processing, ready, errored, or deleted when provided.