Infomaniak Newsletter icon

Infomaniak Newsletter

Interact with Infomaniak Newsletter API

Webforms → Fetch A Webform

AI-generated

Summary

Fetches a specific Infomaniak Newsletter webform using the provided domain and webform IDs.

Inputs

  • Authentication (required) — Authentication method for the request (OAuth2 or API Key).
  • Domain (required) — Unique identifier of the Domain.
  • Webform (required) — Unique identifier of the Webform.
  • Additional Query Parameters — Optional query parameters, such as 'with' to load related resources.
  • Return Full Response — When enabled, returns the raw API response; otherwise returns processed webform data.

Output shape

object

Contains the fetched webform data; if Return Full Response is true, contains the complete API response object.

Examples

Example 1: Retrieve a webform with default processing

Set Domain and Webform IDs; leave Return Full Response off.

Example 2: Retrieve a webform with related data

Set Domain and Webform IDs; add a 'with' query parameter (e.g., 'fields'); keep Return Full Response off.

Example 3: Retrieve raw API response

Set Domain and Webform IDs; enable Return Full Response.

Links

Discussion