Buttondown logo

Listing surveys

Use the /surveys endpoint to list all of your surveys. Surveys let you ask your subscribers a question in any email and personalize future emails based on their answers.

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/surveys"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}

response = requests.request("GET", url, headers=headers)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "results": [
        {
            "id": "srv_0k28edc3fw896bp4mrhc535z5k",
            "creation_date": "2020-09-29T00:00:00+00:00",
            "identifier": "color",
            "question": "What's your favorite color?",
            "response_count": 11,
            "answers": [
                "Red",
                "Green",
                "Blue"
            ],
            "notes": "",
            "randomize_answers": false,
            "response_cadence": "once",
            "status": "active",
            "is_freeform_response_enabled": false,
            "input_type": "radio"
        }
    ],
    "count": 1
}

Path parameters

Consult the Filtering documentation for more information on how to filter and sort your requests.

status

Type
SurveyStatus[]
Description

If provided, only return surveys with the given status.

-status

Type
SurveyStatus[]
Description

If provided, only return surveys without the given status.

ordering

Type
string
Description

The ordering to apply to the results.

Values
  • creation_date
  • -creation_date
  • question
  • -question
  • identifier
  • -identifier
  • status
  • -status
  • response_count
  • -response_count