BUbuttondown
Comments

Retrieve Comment

Changed on

Retrieve a specific comment by its ID

get/comments/{id}

Request

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

Path parameters

idstring required

Response

OK

idstring required

A unique TypeID associated with the object.

creation_datestring date-time required

The date and time at which the object was first created.

email_idstring required

The ID of the email this comment is attached to.

subscriber_idstring nullable

The ID of the subscriber who posted the comment, or null if posted by the newsletter author.

parent_idstring nullable

The ID of the parent comment, if this comment is a reply to another comment.

textstring required

The text content of the comment.

status'pending' | 'active' | 'spammy' required

An enumeration.

Example response

{
  "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