Skip to Content
annotyDocs
annotyDocs
annoty.appDashboardGetting started

Share with reviewers

Proxy or embed?ProxyEmbedScreenshotsToolbar position

Coding agents

Coding agents (MCP)Send to agent

Integrations

SlackWebhooksDiscordEmailZapiern8n

Reference

GlossaryPlans and billingGet help and send feedback
REST API
List a feedback session's comments GETGet a comment GETResolve or reopen a comment PATCHDelete a comment or reply DELETEGet a comment's screenshot GETReply to a comment POSTSend a comment to a coding agent POST
REST APIComments

Get a comment

List a feedback session's comments GET

Threads, newest (highest pin number) first, each with its replies. Requires `comment:read`.

Resolve or reopen a comment PATCH

Open widgets update right away. Replies have no status of their own. Requires `comment:resolve`.

GET
/v1/feedback-sessions/{feedbackSessionId}/comments/{commentId}

With its replies. A reply's id is a 404: replies come inside their comment. Requires comment:read.

Authorization

apiKey
headerAuthorizationBearer <token>

An organization API key from the dashboard (Settings → API keys), e.g. Authorization: Bearer annoty_.... x-api-key: annoty_... also works. While the organization has no subscription or trial, every request with a key except GET /v1/organization fails with 402 SUBSCRIPTION_REQUIRED.

Path Parameters

feedbackSessionId*string
commentId*string

Response Body

The comment

application/json
  1. response
  1. response
  2. …
id*string
feedbackSessionId*string
number*|

The pin number reviewers see, unique within the feedback session

pagePath*string
selector*string

CSS selector of the element the pin is on

body*string
authorName*string
authorId*|

Anonymous id of the reviewer's browser: the same reviewer keeps it across comments. Null on old comments.

authorUserId*|

The org member's user id when they commented signed in on the feedback session; null for reviewers

authorApiKeyId*|

The API key's id when it came through the API with a key, e.g. an agent's reply over MCP. Widgets show it as from the team, like a member's

status*string
Value in"open""resolved"
resolvedAt*|
Formatdate-time
resolvedBy*|

A reviewer's authorId, user:<id> when an org member resolved it (in the widget or through the API), or apiKey:<id>

resolvedByName*string|null
createdAt*string
Formatdate-time
updatedAt*|
Formatdate-time
context*|

What the reviewer's browser showed when they pinned the comment. Null on older comments

replies*array<>

Oldest first

Example Request
curl -X GET 'https://api.annoty.app/v1/feedback-sessions/string/comments/string'
Example Response
{
  "id": "string",
  "feedbackSessionId": "string",
  "number": 0,
  "pagePath": "string",
  "selector": "string",
  "body": "string",
  "authorName": "string",
  "authorId": "string",
  "authorUserId": "string",
  "authorApiKeyId": "string",
  "status": "open",
  "resolvedAt": "2019-08-24T14:15:22Z",
  "resolvedBy": "string",
  "resolvedByName": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "context": {
    "pageUrl": "string",
    "elementText": "string",
    "elementHtml": "string",
    "viewport": {
      "width": 0,
      "height": 0
    },
    "userAgent": "string",
    "screenshot": {
      "url": "string",
      "width": 0,
      "height": 0,
      "element": {
        "x": 0,
        "y": 0,
        "width": 0,
        "height": 0
      }
    }
  },
  "replies": [
    {
      "id": "string",
      "body": "string",
      "authorName": "string",
      "authorId": "string",
      "authorUserId": "string",
      "authorApiKeyId": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}