BEbeyondwords
Playlists

Get playlist

Changed on

Returns a single playlist by ID.

get/projects/{project_id}/playlists/{id}

Request

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

Query parameters

filter[content.title]string

filter by content title

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 content/items/metadata deprecated