Actions70
- API Key Actions
- Campaigns Actions
- Credits Actions
- Domains Actions
- Fields Actions
- Groups Actions
- Operations Actions
- Segments Actions
- Subscribers Actions
- Templates Actions
- Webforms Actions
Subscribers → Filter Subscribers
AI-generatedSummary
Filters Infomaniak Newsletter subscribers.
Inputs
- authentication (required) — OAuth2 or API Key authentication method (default OAuth2).
- path_domain (required) — Numeric identifier of the Infomaniak domain.
- queryParameters — Optional query parameters for pagination, sorting, field expansion, and limiting results (with, extra, return total, limit, skip, page, perPage, orderBy, order, orderFor).
- bodyParameters.filter — JSON filter expression applied to the subscriber collection.
- bodyParameters.segment — String identifier of a pre‑defined segment to further restrict the result set.
- returnFullResponse — When true, returns the full raw API response instead of just the data array (default false).
Output shape
Array of subscriber objects matching the filter/segment, respecting pagination and sort options. If queryParameters.return is set to 'total', returns the total count as a number. If returnFullResponse is true, returns the complete HTTP response object from the Infomaniak API.
All query parameters are optional; omit them to use the API defaults. The filter and segment fields are passed in the request body.
Examples
Example 1: Get first 50 active subscribers sorted by email descending.
Authentication: OAuth2, Domain: 12345, Query: limit=50, orderBy=email, order=desc, Body filter: { status: 'active' }