Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Media → List Media.

AI-generated

Summary

Retrieve a list of media items from a specified channel with optional pagination and filtering parameters.

Inputs

  • Authentication (required) — Choose method for authenticating the request (OAuth2 or API Key).
  • Channel (required) — The unique identifier of the channel to list media from.
  • Additional Query Parameters — Optional parameters to customize the list response: 'Return' to get total count instead of items, 'Page' to specify the page number, and 'Per Page' to set items per page.
  • Return All — Whether to return all media items across all pages (true) or limit per specified 'Limit' (false). Defaults to true.
  • Limit — When 'Return All' is false, the maximum number of media items to return, between 1 and 500. Defaults to 50.
  • Return Full Response — When enabled, returns the full API response object instead of just the media items list.

Output shape

a list of media items or, if 'returnFullResponse' is true, the full API response object; optionally just the total count if 'Return' parameter is set to 'total'.

Pagination parameters 'Page' and 'Per Page' control which subset of media is returned if 'Return All' is false. Use 'Return All' to automatically fetch and aggregate all pages. If 'Return' is set to 'total', the response contains only the count of media items. Error details follow the API standard. The 'Channel' parameter is mandatory to specify the media source.

Links

Discussion