Buttondown logo

Listing tags

Use the /tags endpoint to list all of your tags. Tags let you group your subscribers so you can send emails only to people with (or without) specific tags.

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/tags"
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": [
        {
            "name": "VIP",
            "color": "#FFD700",
            "description": "VIP subscribers",
            "public_description": null,
            "subscriber_editable": false,
            "id": "sub_tag_0k28edc3fw896bp4mrhc535z5k",
            "creation_date": "2020-09-29T00:00:00+00:00",
            "secondary_id": 1
        }
    ],
    "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 tags matching the given IDs.

page_size

Type
string
Description

The number of results per page.