Actions92
- Channel Actions
- Channel > Config Actions
- Event Actions
- Integrations Actions
- Live Actions
- Misc > Countries Actions
- Misc > Stream Actions
- Option Actions
- Option > Record Actions
- Option > Record > Instant Actions
- Option > Record > Storage Actions
- Option > Timeshift Actions
- Option > Watermarking Actions
- Option > Simulcast Actions
- Players Actions
- Players > Ads Actions
- Players > Embeds Actions
- Players > Pictures Actions
- Prices Actions
- Restrictions Actions
- Stats > Channel > Connection History Actions
- Stats > Channel > Consumption Actions
- Stats > Channel > Export Stats Actions
- Stats > Channel > Geolocation Actions
- Stats > Channel > Technologies Actions
- Stats > Channel > Viewers Actions
- Stats > Channel > Viewing Actions
- Stats > Globals > Consumption Actions
- Stats > Globals > Geolocation Actions
- Stats > Globals > Viewers Actions
- Stats > Globals > Viewing Actions
- Thumbnail Actions
- Order Actions
Players → Return A Player
AI-generatedSummary
Return a player by specifying channel and player IDs with optional authentication and query parameters.
Inputs
- authentication — Method of authentication to use, either OAuth2 or API Key.
- path_channel (required) — The unique identifier (ID) of the channel to request.
- path_player (required) — The unique identifier (ID) of the player to request.
- query_account_id (required) — The account identifier.
- queryParameters — Additional query parameters; optional field to load extra resource data.
- returnFullResponse — When true, the full API response is returned; otherwise only the player object is returned.
Output shape
a player object (or full API response when returnFullResponse true)
The returned object contains the player's details; returning the full response includes headers and additional metadata.
Examples
Example 1: Retrieve a specific player within a channel using API Key authentication.
authentication=apiKey&path_channel=123&path_player=456&query_account_id=789
Example 2: Fetch a player with extra data and return the complete response.
authentication=oauth2&path_channel=1&path_player=2&query_parameters={"with":"subtitles"}&returnFullResponse=true