Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Mixtape → List Media In Mixtape.

AI-generated

Summary

List media items contained within a specified Mixtape by its unique identifier, optionally controlling pagination, total count, and response detail.

Inputs

  • Authentication (required) — Choose the authentication method to access the Infomaniak API, either OAuth2 or API Key.
  • Mixtape (required) — The unique identifier of the Mixtape 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 page number, and 'Per Page' to limit the number of items per page.
  • Return All — A boolean flag to indicate whether to retrieve all media items across all pages (true) or limit to a specific number (false). Defaults to true.
  • Limit — If 'Return All' is false, sets the maximum number of media items to return, with a minimum of 1 and maximum of 500. Defaults to 50.
  • Return Full Response — If true, returns the complete API response object including metadata, otherwise returns only the data array or total count as applicable.

Output shape

Returns either a list of media items in the specified Mixtape, a total count of those items, or the full response object depending on parameters.

Pagination is supported via 'Page' and 'Per Page' parameters; setting 'Return All' to true ignores pagination and returns all media items. Using the 'Return' parameter with value 'total' returns only the count of items rather than the items themselves. The 'Return Full Response' option controls whether workflow receives only the data or the entire response envelope.

Examples

Example 1: Retrieve all media items from a specific Mixtape with default pagination

Set 'Mixtape' to the desired ID, use default 'Return All' as true, and default authentication method.

Example 2: Get only the total number of media items in a Mixtape

Set 'Mixtape' ID, 'Return' parameter to 'total', and optionally choose 'Return Full Response' true to get the complete metadata.

Links

Discussion