Survey Responses

Retrieve Survey Responses

List all survey responses

get/survey_responses

Query parameters

email_idstring[]

If provided, only return responses submitted from the given email ID(s).

[
  "em_01jv2m9q8r7s6t5w4x3y2z1abc"
]

automation_idstring[]

If provided, only return responses submitted from the given automation ID(s).

[
  "aut_01jv2m9q8r7s6t5w4x3y2z1abc"
]

subscriber_idstring[]

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

[
  "sub_01jv2m9q8r7s6t5w4x3y2z1abc"
]

sourcestring[]

If provided, only return responses submitted from the given arbitrary source string(s).

[
  "landing-page"
]

survey_idstring[]

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

[
  "srv_01jv2m9q8r7s6t5w4x3y2z1abc"
]

creation_date__startstring date

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

creation_date__endstring date

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

expandstring[]

If provided, expand the given field.

pageinteger

The page number of the paginated response.

Example:1

The page number of the paginated response.

Response

nextstring nullable

The URL to the next page of results, if any.

previousstring nullable

The URL to the previous page of results, if any.

countinteger required

The total number of results across all pages.

Example response

{
  "results": [
    {
      "subscriber": {
        "country": "US",
        "email_address": "telemachus@buttondown.email",
        "delivered_count": 12,
        "open_count": 7,
        "clicked_count": 3,
        "open_rate": 0.5833,
        "click_rate": 0.25
      },
      "email": {
        "slug": "welcome-to-the-newsletter"
      }
    }
  ]
}

Changes

Changed in 5 of the 11 revisions of this API.82

Aug 27, 2026e0ac41d864642See the full diff
- ○
  removed the email_address_cleantalk_score enum value from the results/items/subscriber/anyOf[subschema #1: Subscriber]/firewall_reasons/items/code response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the ip_address_cleantalk_score enum value from the results/items/subscriber/anyOf[subschema #1: Subscriber]/firewall_reasons/items/code response property for the response status 200
  response-property-enum-value-removed
Aug 14, 20260c0c3e81fc961See the full diff
- ●
  added the new email.send.started enum value to the results/items/automation/anyOf[subschema #1: Automation]/trigger response property for the response status 200
  response-property-enum-value-added
Aug 8, 20263a702c095d224See the full diff
- ●
  added the new archive_only enum value to the results/items/email/anyOf[subschema #1: Email]/archival_mode response property for the response status 200
  response-property-enum-value-added
- ●
  added the new email_address_plus_variant_accounts enum value to the results/items/subscriber/anyOf[subschema #1: Subscriber]/firewall_reasons/items/code response property for the response status 200
  response-property-enum-value-added
- ●
  added the new registration_without_prior_page_visit enum value to the results/items/subscriber/anyOf[subschema #1: Subscriber]/firewall_reasons/items/code response property for the response status 200
  response-property-enum-value-added
- ●
  added the new username_shannon_entropy enum value to the results/items/subscriber/anyOf[subschema #1: Subscriber]/firewall_reasons/items/code response property for the response status 200
  response-property-enum-value-added
Aug 5, 202671b271a0f44a1See the full diff
- ●
  added the new email_address_domain_burst enum value to the results/items/subscriber/anyOf[subschema #1: Subscriber]/firewall_reasons/items/code response property for the response status 200
  response-property-enum-value-added
Jul 26, 2026fc5d382abadb2See the full diff
- ●
  added the new remove_metadata enum value to the results/items/automation/anyOf[subschema #1: Automation]/actions/items/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new smtp enum value to the results/items/email/anyOf[subschema #1: Email]/source response property for the response status 200
  response-property-enum-value-added

Full history