BUbuttondown
Surveys

List Surveys

Changed on

List all surveys

get/surveys

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/surveys
  • Auth
    API key in header Authorization

Query parameters

statusSurveyStatus[]

If provided, only return surveys with the given status.

[
  "active"
]
-statusSurveyStatus[]

If provided, only return surveys without the given status.

[
  "inactive"
]
ordering'creation_date' | '-creation_date' | 'question' | '-question' | 'identifier' | '-identifier' | 'status' | '-status' | 'response_count' | '-response_count'

The ordering to apply to the results.

Example:-creation_date
pageinteger

The page number of the paginated response.

Example:1

Response

OK

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.

Changes

  • 228cc05ba97dRevision changes
    • info

      added the new optional query request parameter page

    • info

      added the non-success response with the status

  • 13f3bc084194Revision changes
    • breaking

      response property next list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property previous list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from no type to string for status

    • info

      the endpoint scheme security ApiKeyAuth was added to the API

    • info

      the endpoint scheme security PermissionAuthenticationRequirement was removed from the API

    • info

      api tag Surveys added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status