Infomaniak Newsletter icon

Infomaniak Newsletter

Interact with Infomaniak Newsletter API

Campaigns → List All Campaigns

AI-generated

Summary

Retrieve a list of newsletter campaigns for a specified Infomaniak domain.

Inputs

  • authentication — Authentication method to use: OAuth2 or API Key.
  • path_domain (required) — The unique numeric identifier of the Infomaniak domain.
  • queryParameters — Additional query parameters to filter, sort, format, or paginate the campaigns request.
  • returnAll — Whether to return all retrieved campaigns or limit the number of results.
  • limit — Max number of results to return when Return All is disabled (between 1 and 500).
  • returnFullResponse — Whether to return the complete raw API response envelope instead of extracting only the records.

Output shape

a list of items

Returns an array of campaign records by default. If Return Full Response is enabled, the complete raw API wrapper object is returned.

Examples

Example 1: Retrieve all campaigns for a specific Infomaniak domain

Set Domain (path_domain) to 123456 and leave Return All as true.

Example 2: Fetch a limited list of campaigns with additional query details

Set Domain (path_domain) to 123456, disable Return All, set Limit to 20, and add query_with parameter under Additional Query Parameters.

Links

Discussion