Actions118
- Mailbox Management Actions
- Mailboxes Actions
- Mailboxes > Accesses > Devices Actions
- Mailboxes > Accesses > Invitations Actions
- Mailboxes > Accesses > Webmail Actions
- List User Access And Invitations
- Create Webmail Access
- Set The Primary Mailbox For The Authenticated User
- List Users Having Access
- List Of User Accesses For The Current User
- List Of User Accesses For A Account And A User
- Update Webmail Access
- Delete Webmail Access
- Delete Access To A Mailbox For The Current User
- Mailboxes > Aliases Actions
- Mailboxes > Auto Reply Actions
- Mailboxes > Folders Actions
- Mailboxes > Forwarding Actions
- Mailboxes > Sieve Filters Actions
- Mailboxes > Signatures Actions
- Mailboxes > Users Actions
- Mailing List Actions
- Mailing List > Subscribers Actions
- Service Mail > Auto Reply Actions
- Service Mail > Bimi Actions
- Service Mail > Filters Models Actions
- Service Mail > Preferences Actions
- Service Mail > Redirections Actions
- Service Mail > Redirections > Target Actions
- Service Mail > Signatures Templates Actions
Mailing List > Subscribers → All Subscribers
AI-generatedSummary
List all subscribers of a specified mailing list.
Inputs
- authentication — Authentication method (OAuth2 or API Key).
- path_mail_hosting_id (required) — Identifier of the Infomaniak mail hosting.
- path_mailing_list_name (required) — Name of the mailing list to query.
- query_search — Search term to filter subscribers.
- query_page — Page number for pagination.
- query_per_page — Number of items per page.
- query_order_by — Field to sort results by.
- query_order — Sort order (asc or desc).
- query_order_for — JSON object defining sorting order for a field.
- returnAll — If true, return all items without pagination limits.
- limit — Maximum number of items to return (1‑500).
- returnFullResponse — If true, return the full API response; otherwise only the items.
Output shape
array of subscriber objects (or a total count when query_return=total)
Pagination controlled by query_page and query_per_page; query_return with value total returns only the count; returnFullResponse toggles inclusion of full API payload.
Examples
Example 1: Retrieve all subscribers using OAuth2 authentication
authentication=oauth2&path_mail_hosting_id=123&path_mailing_list_name=NewsletterX
Example 2: Get first page of subscribers with a search filter
authentication=apiKey&path_mail_hosting_id=456&path_mailing_list_name=Promotions&query_search=VIP&query_page=1&query_per_page=20
Example 3: Return only the total subscriber count
authentication=oauth2&path_mail_hosting_id=789&path_mailing_list_name=Updates&query_return=total