Infomaniak Core Ressource icon

Infomaniak Core Ressource

Interact with Infomaniak Core Ressource API

Actions73

User Management > Accounts → List Users

AI-generated

Summary

Lists user accounts from the selected Infomaniak account.

Inputs

  • authentication (required) — Authentication method to use for the request (OAuth2 or API Key).
  • account (required) — Identifier of the Infomaniak account whose users should be listed.
  • query_with — Optional string to load additional related data about each user.
  • query_filter — Optional JSON filter to narrow down the user list.
  • query_order_by — Optional field name to sort the results by.
  • query_order_for — Optional JSON definition of sorting order for a specific field.
  • query_search — Optional search string to filter users.
  • query_return — If set to 'total', the operation returns the count of users instead of the user objects.
  • query_page — Optional page number for paginated results.
  • query_per_page — Optional number of items per page for paginated results.
  • query_order_by_string — Alternative string field used for sorting (duplicate of query_order_by).
  • query_order — Optional sort direction: 'asc' or 'desc'.
  • returnAll — When true, retrieves all pages automatically; otherwise uses limit and pagination settings.
  • limit — Maximum number of items to return per page when returnAll is false (1‑500).
  • returnFullResponse — When true, includes the full HTTP response (headers, status code) in the output.

Output shape

array of user objects

If query_return is set to 'total', the output is a single number representing the total count. When returnFullResponse is true, the output includes the complete response object from the API.

Examples

Example 1: List first 50 users from the default account

Authentication: OAuth2, Account: 0, Return All: false, Limit: 50

Example 2: Get total number of users

Authentication: API Key, Account: 1, Query Return: total

Links

Discussion