Buttondown logo

Listing a survey's responses

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/survey_responses"
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": "resp_0k28edc3fw896bp4mrhc535z5k",
            "creation_date": "2020-09-29T00:00:00+00:00",
            "answer": "Red",
            "text": "",
            "survey_id": "srv_0k28edc3fw896bp4mrhc535z5k",
            "subscriber_id": "sub_0k28edc3fw896bp4mrhc535z5k",
            "email_id": null,
            "automation_id": null,
            "subscriber": null,
            "survey": null,
            "email": null,
            "automation": null
        }
    ],
    "count": 1
}

Path parameters

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

email_id

Type
string
Description

If provided, only return responses made to the given email.

subscriber_id

Type
string
Description

If provided, only return responses made by the given subscriber.

survey

Type
array
Description

If provided, only return responses made to the given survey(s).

creation_date__start

Type
string
Description

If provided, only return responses made after the given date.

creation_date__end

Type
string
Description

If provided, only return responses made before the given date.

expand

Type
array
Description

If provided, expand the given field.