latestOpenAPI 3.0.32026-08-208185259.4 KB

f00047222b8f

Playlists

Fetch playlists

This API fetches all playlists.

get/api/v1/playlists

Query parameters

filter[conversation]string

If specified, only playlists containing moments from the specified conversation will be returned.

include_parentboolean

Used in conjunction with filter[parent], specifies whether the playlist referenced by filter[parent] should also be returned.

filter[name]string

The name of the playlist.

filter[parent]integer

The playlist parent.

recursiveboolean

Used in conjunction with filter[parent], specifies whether all children should be returned (recursively) or only direct children.

filter[subscribed]boolean

Specify true to return only playlists you are currently subscribed to.

top_levelboolean

Specify true to return top-level playlists, only. Note: a top-level playlist is either a playlist with no parent or a playlist whose parent is not visible to the current user.

filter[type]string

Filter by type. Value must be a comma-delimited list. Each item must be one of the following: BOOKMARKS, HASHTAG_PLAYLIST, PINNED_MOMENTS, PLAYLIST, SMART_PLAYLIST

sortstring

A comma-delimited list of fields to sort by. Value must be a comma-delimited list. A maximum of 1 values may be specified.

page[number]integer

The page of playlists to return.

page[size]integer

The number of playlists to return per page.

Response

Success