BUbuttondown
Forms

List Forms

Changed on

List all forms

get/forms

Request

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

Query parameters

statusFormStatus[]

If provided, only return forms with the given status.

[
  "active"
]
-statusFormStatus[]

If provided, only return forms without the given status.

[
  "disabled"
]
adminboolean

If provided, filter by admin-only flag.

ordering'creation_date' | '-creation_date' | 'title' | '-title' | 'slug' | '-slug' | 'status' | '-status'

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.

Example response

{
  "results": [
    {
      "tags": [
        "sub_tag_0k28edc3fw896bp4mrhc535z5k"
      ]
    }
  ]
}

Changes