Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Share → List Media Shares.

AI-generated

Summary

List all share entities associated with a specific media item identified by its unique media ID, optionally applying pagination and filtering parameters.

Inputs

  • Authentication (required) — Select the authentication method to use: OAuth2 or API Key.
  • Media (required) — The unique identifier of the media item whose shares are to be listed.
  • Additional Query Parameters — Optional filters and pagination to control the returned shares, including Expired Since (ISO string), Expires In (duration), Return (set to 'total' to get count instead of items), Page number, and items per page.
  • Return All — Boolean that, if true, retrieves all shares by automatically paging through results; if false, limits results to the specified 'Limit'.
  • Limit — Number controlling the maximum number of shares returned when 'Return All' is false, with valid range 1 to 500.
  • Return Full Response — Boolean determining whether to return the full API response including metadata, instead of only the shares list.

Output shape

a list of share entries or a total count (if Return parameter 'total' is set), optionally paginated, or a full API response object.

If 'Return All' is enabled, the node automatically fetches all pages of shares. The 'Return' query parameter, when set to 'total', causes the response to contain only the total number of shares rather than the share items themselves. Pagination parameters ('Page' and 'Per Page') apply only when 'Return All' is false. The 'Return Full Response' option controls if the output includes metadata or just the main data array.

Links

Discussion