Playlists

List a playlist's videos

get/api/v1/playlists/{id}/videos

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/playlists/{id}/videos
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: playlists:read)

Path parameters

idstring required

playlist ID

Query parameters

archivedboolean

Archived filter: omitted or false returns only non-archived videos; true returns only archived ones

fieldsstring

Comma-separated subset of response fields to return, e.g. id,caption,duration. id is always included. Use it to cut response size on list calls. Valid fields: id, access, audio_disabled, caption, content_generation_type, description, duration, hashtags, archived_at, published_at, is_published, action_type, action_type_translation, action_url, action_custom_label, product_ids, variant_ids, custom_fields, display_social_attributions, external_media, thumbnail_url, watch_url, video_posters.

pageinteger

Page number (default 1)

page_sizeinteger

Page size (default 10, max 100)

Response

Paginated videos

Changes

No recorded changes to this operation across all 1 revision of this API.