Infomaniak Newsletter icon

Infomaniak Newsletter

Interact with Infomaniak Newsletter API

Segments → Fetch A Segment

AI-generated

Summary

Fetch a specific segment from Infomaniak Newsletter

Inputs

  • authentication (required) — Authentication method (OAuth2 or API Key)
  • path_domain (required) — Unique identifier of the Domain (number)
  • path_segment (required) — Unique identifier of the Segment (number)
  • queryParameters — Additional query parameters to include related data (With, Newsletter Id, Segment Id)
  • returnFullResponse — If true, returns the full HTTP response; otherwise returns only the data

Output shape

json

Returns the segment object from the Infomaniak API. When Return Full Response is enabled, the full HTTP response is returned.

Examples

Example 1: Retrieve a segment and include related newsletter data

Set Domain and Segment IDs, add a 'With' parameter with value 'newsletter', keep Return Full Response disabled

Links

Discussion