Actions70
- API Key Actions
- Campaigns Actions
- Credits Actions
- Domains Actions
- Fields Actions
- Groups Actions
- Operations Actions
- Segments Actions
- Subscribers Actions
- Templates Actions
- Webforms Actions
Credits → List All Credits
AI-generatedSummary
Lists all credits for a specified Infomaniak domain, with optional filtering, sorting, pagination, and limits.
Inputs
- authentication (required) — Authentication method for the Infomaniak API (OAuth2 or API Key).
- domain (required) — Numeric identifier of the Infomaniak domain whose credits are to be listed.
- queryParameters — Container for optional query parameters such as filters, pagination, sorting, and fields to include.
- returnAll — If true, fetches all pages of results; if false, respects the 'limit' setting.
- limit — Maximum number of items to return per page when 'returnAll' is false (1‑500).
- returnFullResponse — When true, returns the full HTTP response (including headers and status); when false, returns only the data items.
Output shape
When 'queryParameters.return' is not set to 'total', returns an array of credit objects (or a single page of such objects unless 'returnAll' is true). When set to 'total', returns the total count of credits as a number. If 'returnFullResponse' is true, the entire response object is returned instead.
The exact shape of each credit object follows the Infomaniak API specification for a credit resource.
Examples
Example 1: List all credits for domain 123 using OAuth2 authentication, returning all pages.
Set authentication to OAuth2, domain to 123, returnAll to true.
Example 2: Get only the total number of credits for domain 456, limited to the first 100 items.
Set authentication to API Key, domain to 456, queryParameters.return to total, queryParameters.limit to 100, returnAll to false.