Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Playlist → List Media In Playlist.

AI-generated

Summary

Retrieve media items contained within a specified playlist in Infomaniak's V3 API, supporting pagination and optional total count retrieval.

Inputs

  • Authentication (required) — Select the authentication method to use: OAuth2 or API Key.
  • Playlist (required) — The unique identifier of the playlist from which to list media items.
  • Additional Query Parameters — Optional parameters including 'Return' to request the total count of items instead of the items themselves, 'Page' to specify the pagination page number, and 'Per Page' to define the number of items per page.
  • Return All — Boolean indicating whether to return all media items across all pages (true) or limit results based on pagination settings (false). Defaults to true.
  • Limit — When 'Return All' is false, defines the maximum number of media items to return; minimum 1 and maximum 500 (default 50).
  • Return Full Response — Boolean to specify whether to return the complete API response, including metadata, instead of only the media items.

Output shape

A list of media item objects belonging to the specified playlist if 'Return Full Response' is false; otherwise, the full API response object including pagination metadata and other details.

If 'Return All' is enabled, this operation paginates internally to retrieve all media items. When using 'Return' parameter set to 'total', the response contains only the number of media items rather than the items themselves. Pagination parameters 'Page' and 'Per Page' affect the results only when 'Return All' is false.

Examples

Example 1: List all media items in a playlist using OAuth2 authentication.

Set 'Authentication' to 'OAuth2', specify the 'Playlist' ID, enable 'Return All', and leave other parameters at defaults to receive the full list of media items.

Links

Discussion