Infomaniak Core Ressource icon

Infomaniak Core Ressource

Interact with Infomaniak Core Ressource API

Actions73

User Management > Accounts > Invitations > B2 B → List Customers

AI-generated

Summary

Lists customers for a specified B2B account and invitation in Infomaniak User Management.

Inputs

  • authentication (required) — Authentication method to use for the API request.
  • path_account (required) — Identifier of the B2B account to list customers for.
  • path_invitation (required) — Identifier of the invitation context under which to list customers.
  • queryParameters — Optional collection of query parameters for pagination, sorting, and filtering. Supported sub-parameters include: query_with (load related resource data), query_return (return total count instead of items), query_page (page number), query_per_page (items per page), query_order_by (sort field), query_order (sort order: asc/desc), and query_order_for (per-field sorting order as JSON).
  • returnAll — When true (default), returns all items up to the limit. When false, the limit parameter is strictly applied.
  • limit — Maximum number of items to return. Default 50, clamped between 1 and 500. Only applied when returnAll is false.
  • returnFullResponse — When true, returns the full API response; when false (default), only the items array is returned.

Output shape

An array of customer objects, or a total count if query_return=total is specified in queryParameters.

Pagination is handled via query_page and query_per_page. Sorting is controlled by query_order_by, query_order, and query_order_for. The query_return=total option inverts the response to return only the item count.

Examples

Example 1: List up to 20 customers for account ACC123 under invitation INV456 using OAuth2.

authentication=OAuth2, path_account=ACC123, path_invitation=INV456, queryParameters={query_per_page:20}, returnAll:true

Links

Discussion