Buttondown logo

Listing comments

Use the /comments endpoint to list all of your comments. Comments give your readers a place to talk with each other and stay connected with you.

Sample requests

These sample requests are autogenerated by the OpenAPI spec.

import requests

url = "https://api.buttondown.com/v1/comments"
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": "com_0k28edc3fw896bp4mrhc535z5k",
            "creation_date": "2020-09-29T00:00:00+00:00",
            "email_id": "em_5jrfaebxn7bdp9t3gz58xmrqbe",
            "subscriber_id": "sub_63tkjzd9xrdhygw7sa7d65tvkz",
            "parent_id": null,
            "text": "This is a test comment",
            "status": "active",
            "subscriber": null,
            "email": null
        }
    ],
    "count": 1
}

Path parameters

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

datedate

Filter results by date range. Provide one or more of the following query parameters:

  • date__end (date, on or before (inclusive)): If provided, only return comments created on or before the given date.
  • date__start (date, on or after (inclusive)): If provided, only return comments created on or after the given date.

email_idarray

If provided, only return comments for the given email(s).

expandarray

If provided, expand the given field. (Only supported fields: 'subscriber', 'email').

orderingstring

The ordering to apply to the results.

values
  • creation_date
  • -creation_date
  • email
  • -email
  • subscriber
  • -subscriber

parent_idstring

If provided, only return comments that are replies to the given parent comment.

statusstring[] · enum

If provided, only return comments with the given status(es); otherwise only active comments are returned. Only the newsletter owner can filter by status; subscribers always see active comments.

values
  • pending

    The comment is awaiting moderation.

  • active

    The comment has been approved and is visible.

  • spammy

    The comment has been marked as spam.

subscriber_idstring

If provided, only return comments for the given subscriber.

pagestring

The page number of the paginated response.