FOformbricks
V3 Surveys

Retrieve a survey

Changed on

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}

Request

  • Base URL
    https://app.formbricks.com
  • URL
    https://app.formbricks.com/api/v3/surveys/{surveyId}
  • Auth
    • API key in cookie next-auth.session-token
    • or API key in header x-api-key
    • or HTTP bearer

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

Changes

  • 25335c959a13Revision changes
    • warning

      added the new row enum value to the /////////// response property for the response status

    • warning

      added the new row enum value to the /////////// response property for the response status

  • 82c0afd2df39Revision changes
    • breaking

      added subschema #5: SurveyInteractionFilter to the ///////////// response property oneOf list for the response status