OCT-103 Gumlet outreach
GET/video/playlist

List video playlists

Lists playlists for a video workspace. Use workspace_id to select the workspace; the deprecated collection_id parameter remains available as an alias for the same ID.

2 parameters
workspace_idstringoptional

The video workspace ID to list playlists for. Preferred over the deprecated collection_id alias.

collection_idstringoptional

Deprecated alias for workspace_id; accepted for backwards compatibility and identifies the same workspace.

4 status codes
200Returns an array of playlists, with each object containing its ID and available details such as title, description, workspace ID, and player configuration.
collection_idstringdeprecatedoptional

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

descriptionstringoptional

Description of the playlist

idstringrequired

Playlist ID

player_configobjectoptional

Player configuration for the playlist

titlestringoptional

Title of the playlist

workspace_idstringoptional

Workspace ID

400Returned when the request is invalid.

One documented failure

  • collection_not_found

    Could not find any video collection with specified collection_id.

errorobjectoptional
401Returned when the request has a missing or invalid API key or bearer token.

One documented failure

  • invalid_api_key

    API key supplied with request is invalid

errorobjectrequired
403Returned when the account is unpaid or the authenticated user has 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 is returned when the request has a missing or invalid API key or bearer token. A 403 is returned for an unpaid account or insufficient role permissions. Supply workspace_id or the deprecated collection_id alias to scope the list to a workspace.