Infomaniak Newsletter icon

Infomaniak Newsletter

Interact with Infomaniak Newsletter API

Groups → Fetch A Group

AI-generated

Summary

Fetches a specific Infomaniak Newsletter group by domain ID and group ID.

Inputs

  • authentication (required) — Authentication method (OAuth2 or API Key).
  • path_domain (required) — Numeric ID of the domain containing the group.
  • path_group (required) — Numeric ID of the group to retrieve.
  • queryParameters — Optional additional query parameters; currently supports 'with' to load related data.
  • returnFullResponse — If true, returns the full HTTP response; otherwise returns only the group data.

Output shape

When returnFullResponse is false (default): an object with the group's properties. When true: the full response object from the Infomaniak API.

The operation performs a GET request to the Infomaniak Newsletter endpoint for a specific group within a domain.

Examples

Example 1: Retrieve basic group info

Set domain ID, group ID, keep authentication default, leave queryParameters empty, returnFullResponse false.

Example 2: Include related data

Same as above but add queryParameters.with with the desired relation (e.g., 'contacts').

Links

Discussion