Skip to main content
GET
Get playlist

Authorizations

X-Api-Key
string
header
required

Path Parameters

project_id
string
required

The numeric ID of your project

id
string
required

The numeric ID of your playlist

Query Parameters

filter[content.title]
string

filter by content title

Response

200 - application/json

OK

id
integer

Unique identifier for the object

title
string

The title of the playlist

enabled
boolean

Whether the playlist can be played in the BeyondWords player

type
enum<string>

The type of playlist. The project type is generated automatically. The manual and auto can set content and filter_tags_condition respectively

Available options:
project,
manual,
auto
filter_tags_condition
object | null

The condition used to find content for auto playlists, based on author, title, published_at and tags

content_limit
integer

The maximum number of content items that will appear in the playlist

content
object[]

The content of the playlist (a reduced set of fields are returned). Only the id field is returned for the playlists index endpoint

created
string<date-time>

Time at which the object was created (ISO 8601)

settings
object | null
updated
string<date-time>

Time at which the object was updated (ISO 8601)