Buttondown logo

Get started

Routes

Routes

Listing API requestsRetrieving an API request

Buttondown logo

Listing API requests

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/api_requests"
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": [
        {
            "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
        }
    ],
    "count": 1
}

Path parameters

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

api_key_id

Type
array
Description

If provided, only return requests made with the given API key ID(s).

creation_date__gt

Type
string
Description

If provided, only return requests created after the given datetime.

creation_date__lt

Type
string
Description

If provided, only return requests created before the given datetime.

date__end

Type
string
Description

If provided, only return requests created on or before the given date.

date__start

Type
string
Description

If provided, only return requests created on or after the given date.

limit

Type
string
Description

The maximum number of results to return per page.

method

Type
array
Description

If provided, only return requests with the given HTTP method(s).

path

Type
array
Description

If provided, only return requests matching the given API path(s).

source

Type
[]
Description

If provided, only return requests from the given source(s).

status_code

Type
array
Description

If provided, only return requests with the given HTTP status code(s).

version

Type
array
Description

If provided, only return requests made with the given API version(s).