OCT-103 Gumlet outreach
GET/video/playlist/{playlist_id}/assets

List assets in a playlist

Lists the assets in a playlist, with options to sort the results and select a page. Use the pagination parameters to control the returned page and the sort parameters to choose title order or playlist insertion order.

5 parameters
playlist_idstringrequired

The ID of the playlist whose assets to list.

sort_bystringoptional

Set to asset_title to sort by asset title; otherwise, assets are returned in the order they were added to the playlist.

sort_orderintegeroptional

Sort direction, either -1 or 1. Defaults to 1 when omitted.

Default:1
page_numberintegeroptional

The page number to return; must be at least 1. Defaults to 1 when omitted.

Default:1
page_sizestringoptional

The number of assets to return per page; must be at least 10. Defaults to 10 when omitted.

Default:10

4 status codes
200Returns an object containing the page's asset list, a has_next_page indicator, and the next_page value.
asset_listarray<object>optional

List of assets inside playlist

has_next_pagebooleanoptional
Default:true
next_pageintegeroptional
Default:0
400Returned when the request is invalid, including when a query parameter fails validation.

One documented failure

  • incorrect_playlist_id

    No playlist with provided id exists.

errorobjectrequired
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. The playlist_id path parameter identifies the playlist; sort_order must be -1 or 1, page_number must be at least 1, and page_size must be at least 10.