Buttondown logo

Retrieving email history

Use the /emails/{id}/history endpoint to retrieve the edit history for a given email, showing how its subject, body, and other properties have changed over time.

Sample requests

These sample requests are autogenerated by the OpenAPI spec. This endpoint requires one or more parameters in the URL: those are offset in curly-braces.

import requests

url = "https://api.buttondown.com/v1/emails/{id}/history"
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": [
        {
            "history_id": 123,
            "creation_date": "2000-01-01T00:00:00+00:00",
            "value": "I really hope you enjoy it!",
            "user_id": null,
            "user": null
        }
    ],
    "count": 1
}

Path parameters

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

expand

Type
array
Description

If provided, expand the given field.

field

Type
string · required
Description

The field to retrieve history for.

page

Type
string
Description

The page number of the paginated response.

ordering

Type
string
Description

The ordering to apply to the results.

query

Type
string
Description

If provided, only return history entries matching the given query.

page_size

Type
string
Description

The number of results per page.