v16

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-0124102197.4 KB
V3 Surveys

Retrieve a survey

Returns the public v3 survey management resource for one survey. By default, translatable fields are returned as stable multilingual maps keyed by the language codes emitted in languages[].code. Use lang to filter those maps to one or more requested language selectors.

get/api/v3/surveys/{surveyId}

Path parameters

surveyIdstring cuid2 required

Survey identifier.

Query parameters

langstring[]

Comma-separated language selector filter for translatable fields, for example ?lang=de-DE,pt-PT. The response shape stays stable: translatable fields are always maps, never strings, and response keys match the emitted languages[].code values for this survey. For compatibility with existing Formbricks surveys, GET accepts language tags such as de, de-DE, zh-Hans, and zh-Hans-CN, accepts _ or - separators, is case-insensitive, and accepts configured workspace aliases such as english. Bare language selectors are resolved against the survey's configured languages and return 400 if ambiguous, for example if both en-US and en-GB are configured. Disabled-but-configured languages are readable in the management API so unfinished translations can be completed.

[
  "de-DE"
]

Response

Survey retrieved successfully