Get all players from the CMS
Returns an array of player objects. Players are a read only entity. Players cannot be created or deleted via the API because they need to be linked within a workflow to get content that the player can play back. The player can be a static entity that has the content changing based on various filters, modifiers and query parameters that are set up in the workflow.
The player object is returned after it was evaluated by the workflow in which it is used. It contains the information about the content that populates the player alongside additional information about the player itself.
The player is the end result of a workflow
This means that the player might return different data based on various properties passed by the user, API or the location at which the API call was originated.
Player object structure
Property | Type | Description |
---|---|---|
id | string | The unique id of the player. |
name | string | Player name. |
description | string | The description of the player. This property is used to present additional information about the content of the player. |
src | string | The URL of the modified manifest after the content was evaluated by the workflow in which the player is used. |
thumbnail | string | The URL of the thumbnail to use when presenting the player in the CMS or 3rd party apps |
user | string | The id of the user that created the player. |
organization_owner | string | The id of the user that owns the account in which the player was created. |
created_time | string | The date / time when the player was created. |
updated_time | string | The date / time when the player was last updated. |
workspaces | [string] | The list of the workspaces ids that the player belongs to. Currency limited to a single workflow per player, therefore the length of the array is always 1. |