Player Themes

List all player themes

Retrieve a list of all the player themes you created, as well as details about each one.

get/players

Query parameters

sortBy'name' | 'createdAt' | 'updatedAt'

createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ATOM UTC format.

sortOrder'asc' | 'desc'

Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones.

currentPageinteger

Choose the number of search results to return per page. Minimum value: 1

pageSizeinteger

Results per page. Allowed values 1-100, default is 25.

Response

Success

Example response

{
  "pagination": {
    "itemsTotal": 123,
    "pagesTotal": 7,
    "pageSize": 20,
    "currentPage": 3,
    "currentPageItems": 20,
    "links": {
      "first": {
        "rel": "first",
        "uri": "/videos/search?currentPage=1&pageSize=20"
      },
      "previous": {
        "rel": "previous",
        "uri": "/videos/search?currentPage=2&pageSize=20"
      },
      "next": {
        "rel": "next",
        "uri": "/videos/search?currentPage=4&pageSize=20"
      },
      "last": {
        "rel": "last",
        "uri": "/videos/search?currentPage=6&pageSize=20"
      }
    }
  },
  "data": [
    {
      "trackUnplayed": "trackUnplayed",
      "backgroundTop": "backgroundTop",
      "link": "link",
      "trackPlayed": "trackPlayed",
      "linkHover": "linkHover",
      "backgroundBottom": "backgroundBottom",
      "enableControls": true,
      "backgroundText": "backgroundText",
      "enableApi": true,
      "forceAutoplay": true,
      "trackBackground": "trackBackground",
      "createdAt": "2020-01-31T10:17:47Z",
      "assets": {
        "link": "path/to/my/logo/mylogo.jpg",
        "logo": "mylogo.jpg"
      },
      "hideTitle": true,
      "name": "name",
      "text": "text",
      "linkActive": "linkActive",
      "forceLoop": true,
      "playerId": "pl45KFKdlddgk654dspkze",
      "updatedAt": "2020-01-31T10:18:47Z"
    },
    {
      "trackUnplayed": "trackUnplayed",
      "backgroundTop": "backgroundTop",
      "link": "link",
      "trackPlayed": "trackPlayed",
      "linkHover": "linkHover",
      "backgroundBottom": "backgroundBottom",
      "enableControls": true,
      "backgroundText": "backgroundText",
      "enableApi": true,
      "forceAutoplay": true,
      "trackBackground": "trackBackground",
      "createdAt": "2020-01-31T10:17:47Z",
      "assets": {
        "link": "path/to/my/logo/mylogo.jpg",
        "logo": "mylogo.jpg"
      },
      "hideTitle": true,
      "name": "name",
      "text": "text",
      "linkActive": "linkActive",
      "forceLoop": true,
      "playerId": "pl45KFKdlddgk654dspkze",
      "updatedAt": "2020-01-31T10:18:47Z"
    }
  ]
}

Changes

Changed in 3 of the 50 revisions of this API.66

Apr 16, 2024ec2b79bfdc8d1See the full diff
- ○
  added the non-success response with the status 429
  response-non-success-status-added
Apr 28, 2022f9532dd3578c2See the full diff
- ○
  the endpoint scheme security apiKey was added to the API
  api-security-added
- ○
  the endpoint scheme security bearerAuth was removed from the API
  api-security-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 7, 20222a4d90a64f8863See the full diff
- ●
  the optional response header X-RateLimit-Limit removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Limit removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Remaining removed for the status 400
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 200
  optional-response-header-removed
- ●
  the optional response header X-RateLimit-Retry-After removed for the status 400
  optional-response-header-removed
- ○
  the endpoint scheme security bearerAuth was added to the API
  api-security-added
- ○
  the endpoint scheme security apiKey was removed from the API
  api-security-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
This revision also has 32 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.

Full history