Infomaniak Streaming Radio icon

Infomaniak Streaming Radio

Interact with Infomaniak Streaming Radio API

Actions141

Stations → List Stations

AI-generated

Summary

List stations for a given radio product

Inputs

  • authentication — Authentication method to use. Either OAuth2 (default) or API Key.
  • path_radio_product_id (required) — The unique identifier (ID) of the radio product to request.
  • queryParameters — Additional query parameters to include in the request.
  • query_with — Allows loading additional data about a resource, which may include related resources.
  • query_return — If set to "total", the response will be the number of items in the collection instead of the items themselves.
  • query_limit — Optional parameter that defines the number of items to return (part of offset capacity).
  • query_skip — Optional parameter that defines the index of the first item to return (0 = first item) (part of offset capacity).
  • query_page — Optional parameter that defines the page number (part of pagination capacity).
  • query_per_page — Optional parameter that defines the number of items per page (part of pagination capacity).
  • query_order_by — Optional parameter that defines the field used for sorting (part of sort capacity).
  • query_order — Optional parameter that defines the default sort order (part of sort capacity).
  • query_order_for — Optional parameter that defines the sorting order for a field (part of sort capacity).
  • returnAll — If true, returns the full collection; if false, may return a count or subset.
  • limit — Maximum number of items to return, with a valid range of 1 to 500.
  • returnFullResponse — If true, returns the full API response; otherwise only the items are returned.

Output shape

a paginated list of station objects

The response includes station details and supports pagination; limit can be up to 500, returnAll controls full collection vs count, and returnFullResponse determines whether the full API payload is returned.

Examples

Example 1: Fetch first page of stations for product ID 123 using default limit

authentication=oauth2, path_radio_product_id=123, limit=50, returnAll=true

Example 2: Get total count of stations for product ID 456

authentication=apiKey, path_radio_product_id=456, query_return=total

Example 3: Retrieve up to 10 stations for product ID 789 with limit set

authentication=oauth2, path_radio_product_id=789, query_limit=10, limit=10

Links

Discussion