BEbeyondwords
Playlists

List playlists

Changed on

Lists playlists configured for a project.

get/projects/{project_id}/playlists

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/projects/{project_id}/playlists
  • Auth
    API key in header X-Api-Key

Query parameters

filter[title]string

The partial title to filter by

filter[settings.title]string

The partial settings title to filter by

filter[enabled]boolean
filter[types][]string[]

The types of playlists to return

order[by]'created'

This is used to order playlists by created date

order[dir]'asc' | 'desc'

This is used to order analytics in the ascending or descending order

pagination[limit]integer

'limit' sets the number of results to return in each page.

pagination[offset]integer

'offset' sets the first position to return from the results of the query. The default is 0, which starts the page at the first result.

Response

OK

idinteger

Unique identifier for the object

titlestring

The title of the playlist

enabledboolean

Whether the playlist can be played in the BeyondWords player

type'project' | 'manual' | 'auto'

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

content_limitinteger

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

createdstring date-time

Time at which the object was created (ISO 8601)

updatedstring date-time

Time at which the object was updated (ISO 8601)

Changes

  • 994b9853e685Revision changes
    • warning

      added the new ready enum value to the /// response property for the response status

    • info

      added the optional property /// to the response with the status

    • info

      response property items/content/items/metadata deprecated