Infomaniak Newsletter icon

Infomaniak Newsletter

Interact with Infomaniak Newsletter API

Subscribers → List All Subscribers

AI-generated

Summary

Lists all subscribers for the specified Infomaniak domain, with optional filtering, pagination, sorting, field expansion, and the ability to return a total count or the full HTTP response.

Inputs

  • authentication (required) — Authentication method (OAuth2 or API Key).
  • path_domain (required) — Numeric ID of the domain whose subscribers to list.
  • queryParameters — Container for optional query parameters passed to the Infomaniak API. All sub‑fields are optional unless noted otherwise.
  • returnAll — When true, fetches all matching subscribers; when false, limits the result set using the Limit field (or query‑based pagination).
  • limit — Maximum number of subscribers to return when Return All is false (1‑500). Ignored when Return All is true.
  • returnFullResponse — When true, returns the full HTTP response including headers and status code.

Output shape

The node returns an array of subscriber objects by default. If queryParameters.Return is set to 'total', the output is a number representing the total count of matching subscribers. When Return Full Response is enabled, the output includes the raw API response.

Pagination and sorting can be controlled via the queryParameters sub‑fields: Limit, Skip, Page, Per Page, Order By, Order, Order For. The With parameter expands related resources. The Filter parameter applies a JSON‑based filter to the subscriber list.

Examples

Example 1: Get all subscribers for domain 123

Authentication: OAuth2 (default); Domain: 123; Return All: true (default).

Example 2: Get the first 50 subscribers sorted by email descending

Authentication: OAuth2; Domain: 123; Return All: false; Limit: 50; Order By: email; Order: desc.

Links

Discussion