v1

latestOpenAPI 3.1.02026-07-24251250397.8 KB

players

List players

get/v2/sites/{site_id}/players/

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: name:+testplayer

Players can be queried by the following attributes:

custom_params
id
name
release_channel

Querying for a specific custom_params requires a match using the AND logical operator:

custom_params: ( name: "abc" AND value: "123" )

sortstring

Allows for sorting results

Example: sort=created:dsc

Sort order can be one of asc, dsc

Players can be sorted by the following attributes:

created
last_modified
name

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,
  "players": [
    {
      "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",
      "relationships": {
        "recommendations_playlist": {
          "id": "Ny05CEfj"
        },
        "adschedule": {
          "id": "Ny05CEfj"
        }
      },
      "metadata": {
        "custom_params": {
          "param1": "value1"
        }
      }
    }
  ]
}