JWjwplayer
playlists

List playlists

Changed on
get/v2/sites/{site_id}/playlists/

Request

  • Base URL
    https://api.jwplayer.com
  • URL
    https://api.jwplayer.com/v2/sites/{site_id}/playlists/
  • Auth
    API key in header Authorization

Path parameters

site_idstring required

Unique identifier for a resource

Example:Ny05CEfj

Unique alphanumeric ID of the site

Query parameters

pageinteger

Sets the page number for pagination. First page is 1.

page_lengthinteger

Sets the page length (number of items you get in the response) for pagination

If page_length is not specified, the default value will be set.

Default: 10

qstring

Allows for querying results

Example: title:+a title

Playlists can be queried by the following attributes:

  • author
  • custom_params.name
  • custom_params.value
  • description
  • id
  • link
  • playlist_type
  • title
sortstring

Allows for sorting results

Example: sort=created:dsc

Sort order can be one of asc, dsc

Playlists can be sorted by the following attributes:

  • created
  • last_modified
  • playlist_type
  • title

Response

Resources successfully retrieved

pageinteger

Offset for returned resources

page_lengthinteger

Maximum number of resources to return

totalinteger

Number of resources available before pagination

Example response

{
  "page": 1,
  "page_length": 10,
  "total": 1,
  "playlists": [
    {
      "schema": "https://schema.jwplayer.com/types/thumbnail.json",
      "id": "Ny05CEfj",
      "created": "2019-09-25T15:29:11.042095+00:00",
      "last_modified": "2019-09-25T15:29:11.042095+00:00",
      "metadata": {
        "custom_params": {
          "param1": "value1"
        }
      }
    }
  ]
}

Changes

  • 9fad6bd5872eRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status