Actions70
- API Key Actions
- Campaigns Actions
- Credits Actions
- Domains Actions
- Fields Actions
- Groups Actions
- Operations Actions
- Segments Actions
- Subscribers Actions
- Templates Actions
- Webforms Actions
Segments → List Subscribers
AI-generatedSummary
Retrieves subscribers for a specific segment within an Infomaniak domain.
Inputs
- path_domain (required) — Unique identifier of the Domain. Must be provided.
- path_segment (required) — Unique identifier of the Segment. Must be provided.
- authentication — Connection method. Defaults to OAuth2. Choose OAuth2 or API Key.
- queryParameters — Optional query parameter collection. Supports filtering, pagination, sorting, and result shaping.
- returnAll — When true (default), returns all available subscribers respecting pagination/capacity parameters. When false, the
limitparameter is applied. - limit — Optional number of items to return (1-500). Only applied when
returnAllis false. Default 50. - returnFullResponse — When true, returns the complete API response; when false (default), only the items array is returned.
Output shape
Array of subscriber objects, or total count if query_return is set to total.
Parameter
query_returnwith valuetotalchanges the response to a single total count number instead of the subscriber list.
Examples
Example 1: List all subscribers in segment 42 of domain 1, using API key auth.
path_domain=1, path_segment=42, authentication=apiKey