api.video
  1. Players
api.video
  • Account
    • Show account
      GET
  • Analytics
    • List live stream player sessions
      GET
    • List player session events
      GET
    • List video player sessions
      GET
  • Authentication
    • Authenticate
      POST
    • Refresh token
      POST
  • Live
    • List all live streams
      GET
    • Create live stream
      POST
    • Delete a live stream
      DELETE
    • Show live stream
      GET
    • Update a live stream
      PATCH
    • Delete a thumbnail
      DELETE
    • Upload a thumbnail
      POST
  • Players
    • List all players
      GET
    • Create a player
      POST
    • Delete a player
      DELETE
    • Show a player
      GET
    • Update a player
      PATCH
    • Delete logo
      DELETE
    • Upload a logo
      POST
  • Videos - Delegated upload
    • Upload with an upload token
      POST
    • List all active upload tokens.
      GET
    • Generate an upload token
      POST
    • Delete an upload token
      DELETE
    • Show upload token
      GET
  • Videos
    • List all videos
    • Create a video
    • Delete a video
    • Show a video
    • Update a video
    • Upload a video
    • Show video status
    • Pick a thumbnail
    • Upload a thumbnail
  • Captions
    • List video captions
    • Delete a caption
    • Show a caption
    • Update caption
    • Upload a caption
  • Chapters
    • List video chapters
    • Delete a chapter
    • Show a chapter
    • Upload a chapter
  • Webhooks
    • List all webhooks
    • Create Webhook
    • Delete a Webhook
    • Show Webhook details
  1. Players

List all players

GET
/players
Players
Retrieve a list of all the players you created, as well as details about each one.
Tutorials that use the player endpoint.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://ws.api.video/players'
Response Response Example
200 - response
{
  "data": [
    {
      "backgroundBottom": "rgba(94, 95, 89, 1)",
      "backgroundText": "rgba(255, 255, 255, .95)",
      "backgroundTop": "rgba(72, 4, 45, 1)",
      "createdAt": "2020-01-13T10:09:17.000Z",
      "enableApi": false,
      "enableControls": false,
      "forceAutoplay": false,
      "forceLoop": false,
      "hideTitle": false,
      "link": "rgba(255, 0, 0, .95)",
      "linkActive": "rgba(255, 0, 0, .75)",
      "linkHover": "rgba(255, 255, 255, .75)",
      "playerId": "pl4fgtjy4tjyKDK545DRdfg",
      "shapeAspect": "flat",
      "shapeBackgroundBottom": "rgba(50, 50, 50, .8)",
      "shapeBackgroundTop": "rgba(50, 50, 50, .7)",
      "shapeMargin": 10,
      "shapeRadius": 3,
      "text": "rgba(255, 255, 255, .95)",
      "trackBackground": "rgba(0, 0, 0, 0)",
      "trackPlayed": "rgba(255, 255, 255, .95)",
      "trackUnplayed": "rgba(255, 255, 255, .1)",
      "updatedAt": "2020-01-13T10:09:17.000Z"
    },
    {
      "backgroundBottom": "rgba(94, 95, 89, 1)",
      "backgroundText": "rgba(255, 255, 255, .95)",
      "backgroundTop": "rgba(72, 4, 45, 1)",
      "createdAt": "2020-01-13T10:09:17.000Z",
      "enableApi": true,
      "enableControls": true,
      "forceAutoplay": true,
      "forceLoop": false,
      "hideTitle": false,
      "link": "rgba(255, 0, 0, .95)",
      "linkActive": "rgba(255, 0, 0, .75)",
      "linkHover": "rgba(255, 255, 255, .75)",
      "playerId": "pl54fgtjy4tjyKDK45DRdfg",
      "shapeAspect": "flat",
      "shapeBackgroundBottom": "rgba(50, 50, 50, .8)",
      "shapeBackgroundTop": "rgba(50, 50, 50, .7)",
      "shapeMargin": 10,
      "shapeRadius": 3,
      "text": "rgba(255, 255, 255, .95)",
      "trackBackground": "rgba(0, 0, 0, 0)",
      "trackPlayed": "rgba(255, 255, 255, .95)",
      "trackUnplayed": "rgba(255, 255, 255, .1)",
      "updatedAt": "2020-01-13T10:09:17.000Z"
    }
  ],
  "pagination": {
    "currentPage": 1,
    "currentPageItems": 4,
    "itemsTotal": 4,
    "links": [
      {
        "rel": "self",
        "uri": "https://ws.api.video/players?currentPage=1"
      },
      {
        "rel": "first",
        "uri": "https://ws.api.video/players?currentPage=1"
      },
      {
        "rel": "last",
        "uri": "https://ws.api.video/players?currentPage=1"
      }
    ],
    "pageSize": 25,
    "pagesTotal": 1
  }
}

Request

Query Params
sortBy
string 
optional
createdAt is the time the player was created. updatedAt is the time the player was last updated. The time is presented in ISO-8601 format.
Example:
createdAt
sortOrder
string 
optional
Allowed: asc, desc. Ascending for date and time means that earlier values precede later ones. Descending means that later values preced earlier ones.
Example:
asc
currentPage
integer 
optional
Choose the number of search results to return per page. Minimum value: 1
Example:
2
pageSize
integer 
optional
Results per page. Allowed values 1-100, default is 25.
Example:
30

Responses

🟢200Success
application/json
Body
data
array[object (Player) {24}] 
optional
backgroundBottom
string 
optional
RGBA color: bottom 50% of background. Default: rgba(0, 0, 0, .7)
backgroundText
string 
optional
RGBA color for title text. Default: rgba(255, 255, 255, 1)
backgroundTop
string 
optional
RGBA color: top 50% of background. Default: rgba(0, 0, 0, .7)
enableApi
boolean 
optional
enable/disable player SDK access. Default: true
Default:
true
enableControls
boolean 
optional
enable/disable player controls. Default: true
Default:
true
forceAutoplay
boolean 
optional
enable/disable player autoplay. Default: false
Default:
false
forceLoop
boolean 
optional
enable/disable looping. Default: false
Default:
false
hideTitle
boolean 
optional
enable/disable title. Default: false
Default:
false
link
string 
optional
RGBA color for all controls. Default: rgba(255, 255, 255, 1)
linkHover
string 
optional
RGBA color for all controls when hovered. Default: rgba(255, 255, 255, 1)
text
string 
optional
RGBA color for timer text. Default: rgba(255, 255, 255, 1)
trackBackground
string 
optional
RGBA color playback bar: background. Default: rgba(255, 255, 255, .2)
trackPlayed
string 
optional
RGBA color playback bar: played content. Default: rgba(88, 131, 255, .95)
trackUnplayed
string 
optional
RGBA color playback bar: downloaded but unplayed (buffered) content. Default: rgba(255, 255, 255, .35)
assets
object 
optional
createdAt
string <date-time>
optional
When the player was created, presented in ISO-8601 format.
Example:
2020-01-31T10:17:47.000Z
linkActive
string 
optional
Deprecated
playerId
string 
optional
Example:
pl45KFKdlddgk654dspkze
shapeAspect
string 
optional
Deprecated
shapeBackgroundBottom
string 
optional
Deprecated
shapeBackgroundTop
string 
optional
Deprecated
shapeMargin
integer 
optional
Deprecated
shapeRadius
integer 
optional
Deprecated
updatedAt
string <date-time>
optional
When the player was last updated, presented in ISO-8601 format.
Example:
2020-01-31T10:18:47.000Z
pagination
object (Pagination) 
optional
Example:
{"currentPage":3,"currentPageItems":20,"itemsTotal":123,"links":{"first":{"rel":"first","uri":"/videos/search?currentPage=1&pageSize=20"},"last":{"rel":"last","uri":"/videos/search?currentPage=6&pageSize=20"},"next":{"rel":"next","uri":"/videos/search?currentPage=4&pageSize=20"},"previous":{"rel":"previous","uri":"/videos/search?currentPage=2&pageSize=20"}},"pageSize":20,"pagesTotal":7}
currentPage
integer 
read-onlyoptional
The current page index.
currentPageItems
integer 
read-onlyoptional
The number of items on the current page.
itemsTotal
integer 
read-onlyoptional
Total number of items that exist.
links
array[object (PaginationLink) {2}] 
required
pageSize
integer 
read-onlyoptional
Maximum number of item per page.
pagesTotal
integer 
read-onlyoptional
Number of items listed in the current page.
🟠400Bad Request
Modified at 2023-08-15 05:52:15
Previous
Upload a thumbnail
Next
Create a player
Built with