Playlists
List playlists of a channel
Lists a channel's playlists. channel_id is optional for a token whose business has a single channel; otherwise it is required.
get/api/v1/playlists
Request
- Base URL: https://api.firework.com
- URL: https://api.firework.com/api/v1/playlists
- Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: playlists:read)
Query parameters
channel_idstring
channel ID (optional; defaults to the business's sole channel)
qstring
Search filter: case-insensitive substring match on the playlist name. Use this to find a specific playlist instead of paging the channel.
archivedboolean
Archived filter: omitted or false returns only non-archived playlists; true returns only archived ones
afterstring
Opaque cursor for the next page (from pagination.cursor or links.next); ascending order.
beforestring
Opaque cursor for the previous page; descending order.
page_sizeinteger
Page size (default 10, max 100)
Response
Paginated playlists
Changes
No recorded changes to this operation across all 1 revision of this API.