Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailing List > Subscribers → All Subscribers

AI-generated

Summary

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

Links

Discussion