Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Category → List Categories.

AI-generated

Summary

Retrieve a list of categories from the Infomaniak VOD API, optionally paginating or returning only the total count, with support for OAuth2 or API Key authentication.

Inputs

  • Authentication (required) — Choose the authentication method for the API call: either OAuth2 or API Key.
  • Additional Query Parameters — Optional parameters to control the response: 'Return' to fetch total count instead of items, 'Page' for pagination page number, and 'Per Page' to define items per page.
  • Return All — Boolean to specify if all categories should be returned, ignoring pagination limits.
  • Limit — Limits the number of categories returned if 'Return All' is false, with a minimum of 1 and maximum of 500.
  • Return Full Response — Boolean to determine if the full API response should be returned instead of just the data.

Output shape

Returns either an array of category items or a summary response with the total count, depending on query parameters and option selections.

If 'Return' = 'total' is specified, the response contains the number of categories instead of the list. Pagination parameters ('Page', 'Per Page', 'Limit') and 'Return All' influence whether a partial or complete list is returned. 'Return Full Response' affects whether the raw API response or data extraction is returned.

Links

Discussion