Comments

List comments on a project, web app or document

Returns the newest comments on one parent (a project, web app or document), newest first, up to limit. The fields returned depend on surface. Requires the read scope.

get/comments

Request

  • Base URL: https://app.huddlekit.com/api/v1
  • URL: https://app.huddlekit.com/api/v1/comments
  • Auth: HTTP bearer

Query parameters

parent_idstring uuid required

Id of the project, web app or document (from listProjects). Must belong to the key's workspace.

project_idstring uuid

Deprecated alias of parent_id, used only when parent_id is absent.

surface'website' | 'webapp' | 'document'

What a comment is attached to. website: a website project (the parent is a project). webapp: a web app that runs the Huddlekit SDK widget (the parent is a web app). document: an uploaded PDF, image or video (the parent is a document).

What parent_id refers to. Defaults to website.

limitinteger

Maximum number of comments to return, 1 to 200. Defaults to 50. Out-of-range values are clamped.

Response

Comments on the parent.

surface'website' | 'webapp' | 'document' required

What a comment is attached to. website: a website project (the parent is a project). webapp: a web app that runs the Huddlekit SDK widget (the parent is a web app). document: an uploaded PDF, image or video (the parent is a document).

Example response

{
  "comments": [
    {
      "id": "6b1f9c2e-4d7a-4c1b-9e3f-2a8d5c7b1e04",
      "comment_number": 42,
      "text": "The signup button overlaps the footer on mobile.",
      "status": "open",
      "priority": "Medium",
      "resolved": false,
      "is_private": false,
      "path": "/pricing",
      "screenshot": null,
      "created_at": "2026-09-20T10:15:00.000Z",
      "updated_at": "2026-09-20T10:15:00.000Z"
    }
  ],
  "surface": "website"
}

Changes

No recorded changes to this operation across all 1 revision of this API.