Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Folder → List Folders.

AI-generated

Summary

List folders within a specified channel in the Infomaniak VOD service, supporting pagination and total count retrieval.

Inputs

  • Authentication (required) — Select the authentication method to use: OAuth2 or API Key.
  • Channel (required) — The unique identifier of the channel to list folders from.
  • Additional Query Parameters — Optional query parameters including:
  • Return: If set to 'total', returns the count of folders instead of folder details.
  • Page: The page number for paginated results.
  • Per Page: Number of folders per page in paginated results.
  • Return All — Boolean to determine if all folders should be returned or limited by pagination parameters.
  • Limit — Maximum number of folders to return when pagination is used and Return All is false (1-500).
  • Return Full Response — Boolean to return the entire API response object instead of just the folder data.

Output shape

A list of folder objects or the total count of folders, depending on the query parameters; optionally includes pagination metadata if full response is requested.

When 'Return All' is true, the operation fetches all folders across pages. When false, the 'Limit' or pagination parameters control the number of folders returned. If 'Return' query parameter is set to 'total', the output is a count of folders rather than folder details. Selecting 'Return Full Response' includes full API response details potentially with metadata beyond folder items.

Examples

Example 1: Retrieve all folders in a channel using OAuth2 authentication.

Set authentication to OAuth2, provide the channel ID, enable 'Return All', and execute.

Example 2: Get a paginated list of folders with a limit of 50 folders per page.

Set authentication (OAuth2 or API Key), provide channel ID, disable 'Return All', set 'Limit' to 50, and optionally set 'Page' query parameter for paging.

Example 3: Retrieve the total number of folders in a channel without folder details.

Set authentication, provide channel ID, and add an additional query parameter 'Return' set to 'total'.

Links

Discussion