Buttondown logo

Listing notes

Use the /notes endpoint to list all of your notes. Notes are immutable annotations that can be attached to various objects like emails and subscribers, and become especially powerful when chained with automations.

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/notes"
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": "note_29fxqcmrkp969vzttksexvmvr8",
            "creation_date": "2000-01-01T00:00:00+00:00",
            "body": "This person rocks :)",
            "model_type": "subscriber",
            "model_id": "sub_0k28edc3fw896bp4mrhc535z5k",
            "metadata": {},
            "source": "user",
            "user_id": "acc_6d9ps3y19d89d8wpvkwme1s6w5",
            "user": null
        }
    ],
    "count": 1
}

Path parameters

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

model_type

Type
string
Description

Filter notes by the type of object they are attached to.

model_id

Type
string
Description

Filter notes by the ID of the object they are attached to.

expand

Type
array
Description

If provided, expand the given field.