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
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

Responses

🟢200Success
application/json
Body

🟠400Bad Request
Modified at 2023-08-15 05:52:15
Previous
Upload a thumbnail
Next
Create a player
Built with