Infomaniak Newsletter icon

Infomaniak Newsletter

Interact with Infomaniak Newsletter API

Fields → List All Fields

AI-generated

Summary

Lists all newsletter fields for a given Infomaniak domain, with optional filtering, pagination, sorting, and limit controls.

Inputs

  • authentication — Authentication method to use with the Infomaniak API. Options: OAuth2 (default) or API Key.
  • path_domain (required) — Unique identifier of the Domain whose fields should be listed. Must be a number.
  • queryParameters — Additional query parameters that modify the request. Sub‑parameters include Filter (JSON), Return (set to 'total' to get a count), Limit, Skip, Page, Per Page, Order By, Order (asc/desc), and Order For (custom sort JSON). All are optional.
  • returnAll — When true (default), retrieves all matching fields regardless of the Limit value. When false, limits the result set to the value in the Limit parameter.
  • limit — Maximum number of fields to return when Return All is false. Default is 50, configurable between 1 and 500.
  • returnFullResponse — When true, returns the raw HTTP response (including headers and status code). When false (default), returns only the data payload.

Output shape

array of field objects (each containing at least an id and label) representing the newsletter fields for the domain.

If queryParameters.Return is set to 'total', the output is a single number representing the total count of fields. If returnFullResponse is true, the output is the full HTTP response object instead of the parsed data.

Examples

Example 1: Retrieve all fields for domain ID 123 using OAuth2 authentication.

Set Authentication=OAuth2, Domain=123, leave other parameters at defaults.

Example 2: Get only the total count of fields for domain ID 456.

Set Domain=456, Return All=true, and within Additional Query Parameters set Return to 'total'.

Example 3: Fetch the first 10 fields sorted by label ascending.

Set Domain=, Return All=false, Limit=10, Order By=label, Order=asc.

Links

Discussion