List videos in a channel
Lists a channel's videos. channel_id is optional for an app token whose business has a single channel; otherwise it is required. The pagination object includes total_entries, the exact number of videos matching the current filters.
Request
- Base URL: https://api.firework.com
- URL: https://api.firework.com/api/v1/videos
- Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: videos:read)
Query parameters
channel ID (optional; defaults to the business's sole channel)
Search filter: case-insensitive substring match on the video caption. Use this to find a specific video instead of paging the whole channel.
Filter by status
Filter by access level (public, private, unlisted)
Filter by video type (e.g. live_stream)
Filter by an exact, case-insensitive hashtag. A leading # is significant; use the value returned in a video's hashtags array.
Archived filter: omitted or false returns only non-archived videos; true returns only archived ones
Filter by published state
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.
Opaque cursor for the next page (from pagination.cursor or links.next); ascending order.
Opaque cursor for the previous page; descending order.
Page size (default 10, max 100)
Response
Paginated videos
Changes
No recorded changes to this operation across all 1 revision of this API.