Infomaniak Streaming Radio icon

Infomaniak Streaming Radio

Interact with Infomaniak Streaming Radio API

Actions141

Players → List Product Players

AI-generated

Summary

List product players for a given radio product ID using the Infomaniak Streaming Radio API.

Inputs

  • authentication — Authentication method (OAuth2 or API Key) to use for the request.
  • path_radio_product_id (required) — The unique identifier of the radio product whose players are to be listed.
  • query_with — Optional parameter to include additional related data in the response.
  • query_return — Optional parameter; if set to "total", returns the count of items instead of the items themselves.
  • query_limit — Optional parameter defining the maximum number of items to return.
  • query_skip — Optional parameter specifying the zero‑based index of the first item to return.
  • query_page — Optional parameter indicating the page number for paginated results.
  • query_per_page — Optional parameter defining how many items to include per page.
  • query_order_by — Optional parameter specifying the field to sort by.
  • query_order — Optional parameter defining the sort direction (asc or desc).
  • query_order_for — Optional JSON object defining sorting order for a field.
  • returnAll — If true, returns all matching players regardless of limit; default is true.
  • limit — Maximum number of items to return; constrained between 1 and 500.
  • returnFullResponse — If true, returns the full response payload; otherwise only a subset may be returned.

Output shape

List of product player objects

The response may include pagination metadata (total, limit, offset) and optional fields; the exact structure depends on query parameters such as limit, skip, and pagination settings.

Examples

Example 1: Retrieve players for radio product ID 1234 using OAuth2 with default pagination

authentication=oauth2; path_radio_product_id=1234; returnAll=true

Example 2: Get total count of players for product ID 5678 and limit to 20 items

authentication=apiKey; path_radio_product_id=5678; query_return=total; limit=20

Links

Discussion