BUbuttondown
Comments

List Comments

Changed on

List all comments

get/comments

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/comments
  • Auth
    API key in header Authorization

Query parameters

date__endstring date

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

date__startstring date

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

email_idstring[]

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

[
  "em_01h8xg4j3k2m1n0p9q8r7s6t5v"
]
expandstring[]

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

ordering'creation_date' | '-creation_date' | 'email' | '-email' | 'subscriber' | '-subscriber'

The ordering to apply to the results.

Example:-creation_date
parent_idstring

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

statusCommentStatus[]

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.

[
  "active"
]
subscriber_idstring

If provided, only return comments for the given subscriber.

pageinteger

The page number of the paginated response.

Example:1

Response

OK

nextstring nullable

The URL to the next page of results, if any.

previousstring nullable

The URL to the previous page of results, if any.

countinteger required

The total number of results across all pages.

Example response

{
  "results": [
    {
      "subscriber": {
        "country": "US",
        "email_address": "telemachus@buttondown.email",
        "delivered_count": 12,
        "open_count": 7,
        "clicked_count": 3,
        "open_rate": 0.5833,
        "click_rate": 0.25
      },
      "email": {
        "slug": "welcome-to-the-newsletter"
      }
    }
  ]
}

Changes

  • 594190e20eb7Revision changes
    • warning

      added the new comment_text_contains_link enum value to the ////// response property for the response status

  • 8fff9c6b1347Revision changes
    • warning

      removed the optional property //// from the response with the status

    • info

      removed the email_address_noreply_local_part enum value from the ////// response property for the response status

    • info

      removed the suppressed enum value from the //// response property for the response status