BUbuttondown
Emails

Retrieve Email History

Changed on

Retrieve the edit history for a specific email

get/emails/{id}/history

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/emails/{id}/history
  • Auth
    API key in header Authorization

Path parameters

idstring required

Query parameters

expandstring[]

If provided, expand the given field.

fieldstring required

The field to retrieve history for.

pageinteger

The page number of the paginated response.

Example:1
ordering'creation_date' | '-creation_date'

The ordering to apply to the results.

querystring

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

page_sizeinteger

The number of results per page.

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
    • breaking

      for the query request parameter field, the minLength was increased from 0 to 1

    • 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

  • 13f3bc084194Revision changes
    • breaking

      removed the enum value user from the property items/ of the query request parameter expand

    • 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

      response property results/items/user_id 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

    • breaking

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

    • breaking

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

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the optional property /// from the response with the 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 Emails added

    • info

      added the non-success response with the status

    • info

      added subschema #2 to the // response property anyOf list for the response status