Infomaniak Core Ressource icon

Infomaniak Core Ressource

Interact with Infomaniak Core Ressource API

Actions73

Products → List Products

AI-generated

Summary

Lists Infomaniak products with optional filtering, sorting, and pagination.

Inputs

  • authentication (required) — Choose OAuth2 or API Key to authenticate with the Infomaniak API.
  • queryParameters.With — Optional field to load additional data about each product.
  • queryParameters.Account Id — Filter by account identifier.
  • queryParameters.Customer Name — Filter by customer name.
  • queryParameters.Fqdn — Filter by fully qualified domain name.
  • queryParameters.Internal Name — Filter by internal product name.
  • queryParameters.Product Id — Filter by specific product ID.
  • queryParameters.Service Id — Filter by service ID (numeric options).
  • queryParameters.Service Name — Filter by service name (string options).
  • queryParameters.Return — If set to 'total', returns only the count of matching products.
  • queryParameters.Limit — Maximum number of items to return (offset-based pagination).
  • queryParameters.Skip — Index of the first item to return (offset-based pagination).
  • queryParameters.Page — Page number for page-based pagination.
  • queryParameters.Per Page — Number of items per page for page-based pagination.
  • queryParameters.Order By — Field used to sort the results.
  • queryParameters.Order — Sort direction: 'asc' or 'desc'.
  • queryParameters.Order For — JSON object defining custom sort order for specific fields.
  • returnAll — When true (default), fetches all matching products ignoring limit/skip/page. When false, respects the Limit field (default 50).
  • returnFullResponse — When true, returns the full HTTP response including headers and status code.

Output shape

array of product objects (or a single number when Return = total, or full response object when Return Full Response = true)

Each product object contains fields as returned by the Infomaniak Core Ressource API (e.g., id, name, type, etc.).

Examples

Example 1: List the first 50 products

Authentication = OAuth2, Return All = false (default Limit = 50)

Example 2: Get total count of products for a specific account

Authentication = API Key, Query Parameters.Account Id = 12345, Return = total

Links

Discussion