GET
/
projects
/
{project_id}
/
playlists
List
curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/playlists \
  --header 'X-Api-Key: <api-key>'
[
  {
    "id": 1,
    "title": "My project playlist",
    "enabled": true,
    "type": "project",
    "rules_version": "1.0",
    "rules": [],
    "content_limit": 25,
    "content": [
      {
        "id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd"
      },
      {
        "id": "ed81a10c-83cd-4b1f-ab43-2aa1b4ffefc0"
      },
      {
        "id": "1c0274ba-362d-4dea-8a34-5177061bf032"
      },
      {
        "id": "7449fca4-2ecc-4bb8-9849-ae5c9f194fa6"
      },
      {
        "id": "eb0cbce7-6160-4d11-b0d2-ecb9eb92502c"
      }
    ],
    "settings": null,
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  },
  {
    "id": 2,
    "title": "My manual playlist",
    "enabled": true,
    "type": "manual",
    "rules_version": "1.0",
    "rules": [],
    "content_limit": 25,
    "content": [
      {
        "id": "d7dfd636-098c-4b1b-83e5-15a3cba5a0bd"
      },
      {
        "id": "ed81a10c-83cd-4b1f-ab43-2aa1b4ffefc0"
      },
      {
        "id": "1c0274ba-362d-4dea-8a34-5177061bf032"
      }
    ],
    "settings": null,
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  },
  {
    "id": 3,
    "title": "My auto playlist",
    "enabled": true,
    "type": "auto",
    "rules_version": "1.0",
    "rules": [
      {
        "operator": "and",
        "conjunction": [
          {
            "field": "author",
            "operator": "is",
            "arg": "John Smith"
          }
        ]
      }
    ],
    "content_limit": 25,
    "content": [
      {
        "id": "1c0274ba-362d-4dea-8a34-5177061bf032"
      }
    ],
    "settings": null,
    "created": "2023-01-01 00:00:00 UTC",
    "updated": "2023-01-01 00:00:05 UTC"
  }
]

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
project_id
string
required

The numeric ID of your project

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]
enum<string>

This is used to order playlists by created date

Available options:
created
​
order[dir]
enum<string>

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

Available options:
asc,
desc
​
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

​
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 rules respectively

Available options:
project,
manual,
auto
​
rules_version
enum<string> | null
​
rules
object[]

The rules that will be used to find content for auto playlists

​
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
​
updated
string<date-time>

Time at which the object was updated (ISO 8601)