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

List a feedback session's comments

List where a feedback session was opened GET

Every site a widget opened this feedback session on, its proxy link included, most recently opened first. Only pages with the embed link or the embed key count: the embed script does nothing without one. Requires `feedbackSession:read`.

Get a comment GET

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

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

Threads, newest (highest pin number) first, each with its replies. 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

Query Parameters

limit?integer

Items per page, 1 to 100

Range1 <= value <= 100
Default20
cursor?string

nextCursor from the previous page

status?string
Value in"open""resolved"
pagePath?string

Only comments on this page, e.g. /pricing

Response Body

A page of comments

application/json
  1. response
  1. response
  2. …
data*array<>
nextCursor*|

Pass as cursor for the next page; null on the last page

Example Request
curl -X GET 'https://api.annoty.app/v1/feedback-sessions/string/comments'
Example Response
{
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "nextCursor": "string"
}