Buttondown logo

Retrieving an API request

Use the /api_requests/{id} endpoint to retrieve a single API request, including its stored request body, headers, and, when retained, its response body.

response_data is retained only for requests that included an X-Idempotency-Key. For requests without an idempotency key, response_data will be null.

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/api_requests/{id}"
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.

{
    "id": "api_req_0k28edc3fw896bp4mrhc535z5k",
    "creation_date": "2020-09-29T00:00:00+00:00",
    "status_code": 200,
    "path": "/v1/emails",
    "method": "GET",
    "source": "api",
    "version": "2024-08-01",
    "ip_address": "127.0.0.1",
    "api_key_id": null,
    "api_key_label": null,
    "request_data": "{\"subject\": \"Test email\"}",
    "response_data": "{\"id\": \"123e4567-e89b-12d3-a456-426614174001\"}",
    "headers": {
        "X-Api-Version": "2024-08-01",
        "User-Agent": "buttondown-python/1.0"
    }
}