APapivideo
Player Themes

List all player themes

Changed on

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

get/players

Request

  • Base URL
    https://ws.api.video
  • URL
    https://ws.api.video/players
  • Auth
    HTTP basic

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