Buttondown logo

Listing images

Whether it's to add an image to an email or to use an image in a newsletter, you can use the /images endpoint to list all of your images.

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/images"
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": [
        {
            "creation_date": "2019-08-24T14:15:22Z",
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "image": "https://placecats.com/408/287"
        }
    ],
    "count": 1
}

Path parameters

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

ids

Type
array
Description

If provided, only return images matching the given IDs.

page

Type
string
Description

The page number to return.

page_size

Type
string
Description

The number of results per page.