Management API

Surveys API

The Survey API currently has one endpoint that allows you to get all the surveys you have in your Formbricks environment. You will need the API Key to access the same!

GET/api/v1/management/surveys

List all surveys

Retrieve all the surveys you have for the environment.

Mandatory Headers

Name
x-Api-Key
Type
string
Description
Your Formbricks API key.

Request

GET

/api/v1/management/surveys

curl --location \
'https://app.formbricks.com/api/v1/management/surveys' \
--header \
'x-api-key: <your-api-key>'

Response

{
    "data": [
        {
            "id": "cllnfy2780fromy0hy7uoxvtn",
            "createdAt": "2023-08-23T07:56:20.516Z",
            "updatedAt": "2023-08-23T07:56:26.947Z",
            "name": "Product Market Fit (Superhuman)",
            "type": "link",
            "environmentId": "cll2m30r70004mx0huqkitgqv",
            "status": "inProgress",
            "attributeFilters": [],
            "displayOption": "displayOnce",
            "autoClose": null,
            "triggers": [],
            "redirectUrl": null,
            "recontactDays": null,
            "questions": [
                {
                    "id": "gml6mgy71efgtq8np3s9je5p",
                    "type": "cta",
                    "headline": "You are one of our power users! Do you have 5 minutes?",
                    "required": false,
                    "buttonLabel": "Happy to help!",
                    "logic": [
                        {
                            "condition": "skipped",
                            "destination": "end"
                        }
                    ],
                    "html": "<p class=\"fb-editor-paragraph\" dir=\"ltr\"><span>We would love to understand your user experience better. Sharing your insight helps a lot!</span></p>",
                    "buttonExternal": false,
                    "dismissButtonLabel": "No, thanks."
                },
                {
                    "id": "kp62fbqe8cfzmvy8qwpr81b2",
                    "type": "multipleChoiceSingle",
                    "headline": "How disappointed would you be if you could no longer use My Product?",
                    "subheader": "Please select one of the following options:",
                    "required": true,
                    "choices": [
                        {
                            "id": "bdgy1hnwd7uwmfxk1ljqp1n5",
                            "label": "Not at all disappointed"
                        },
                        {
                            "id": "poabnvgtwenp8rb2v70gj4hj",
                            "label": "Somewhat disappointed"
                        },
                        {
                            "id": "opfiqyqz8wrqn0i0f7t24d3n",
                            "label": "Very disappointed"
                        }
                    ],
                    "shuffleOption": "none"
                },
                {
                    "id": "klvpwd4x08x8quesihvw5l92",
                    "type": "multipleChoiceSingle",
                    "headline": "What is your role?",
                    "subheader": "Please select one of the following options:",
                    "required": true,
                    "choices": [
                        {
                            "id": "c8nerw6l9gpsxcmqkn10f9hy",
                            "label": "Founder"
                        },
                        {
                            "id": "ebjqezei6a2axtuq86cleetn",
                            "label": "Executive"
                        },
                        {
                            "id": "ctiijjblyhlp22snypfamqt1",
                            "label": "Product Manager"
                        },
                        {
                            "id": "ibalyr0mhemfkkr82vypmg40",
                            "label": "Product Owner"
                        },
                        {
                            "id": "fipk606aegslbd0e7yhc0xjx",
                            "label": "Software Engineer"
                        }
                    ],
                    "shuffleOption": "none"
                },
                {
                    "id": "ryo75306flyg72iaeditbv51",
                    "type": "openText",
                    "headline": "What type of people do you think would most benefit from My Product?",
                    "required": true
                },
                {
                    "id": "lkjaxb73ulydzeumhd51sx9g",
                    "type": "openText",
                    "headline": "What is the main benefit your receive from My Product?",
                    "required": true
                },
                {
                    "id": "ec7agikkr58j8uonhioinkyk",
                    "type": "openText",
                    "headline": "How can we improve My Product for you?",
                    "subheader": "Please be as specific as possible.",
                    "required": true
                }
            ],
            "thankYouCard": {
                "enabled": true,
                "headline": "Thank you!",
                "subheader": "We appreciate your feedback."
            },
            "delay": 0,
            "autoComplete": null,
            "closeOnDate": null
        }
    ]
}