Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Player → List Players.

AI-generated

Summary

Retrieve a list of players associated with a specified channel in the Infomaniak VOD service, optionally supporting pagination and returning either all items or a limited subset.

Inputs

  • Authentication (required) — Select the authentication method to use, either OAuth2 or API Key.
  • Channel (required) — The unique identifier of the channel for which to list players.
  • Additional Query Parameters — Optional parameters to control the listing, including 'Return' to request the total count instead of items, 'Page' to specify the page number, and 'Per Page' to set the number of items per page.
  • Return All — Boolean flag indicating whether to return all players or limit results to a specific number.
  • Limit — When 'Return All' is false, specifies the maximum number of players to retrieve (1 to 500).
  • Return Full Response — Boolean flag to indicate if the full API response should be returned instead of just the main data.

Output shape

a list of player objects or a total count (number) depending on query parameters and flags

If 'Return' is set to 'total' in the additional query parameters, the output is the total number of players rather than player details. Pagination is supported via 'Page' and 'Per Page' parameters. When 'Return All' is true, all available players are fetched across pages; otherwise, the 'Limit' parameter restricts the number of players returned. The 'Return Full Response' option returns the complete API response including metadata.

Links

Discussion