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 project's feedback sessions GETCreate a feedback session POSTList the organization's feedback sessions GETGet a feedback session GETUpdate a feedback session PATCHDelete a feedback session DELETEList where a feedback session was opened GET
REST APIFeedback sessions

List a project's feedback sessions

Regenerate the project embed link POST

Gives the project a new `embedKey`: every project embed link shared so far stops working, and widgets opened with one leave on their next connect. Feedback sessions it created keep their comments and their own `embedUrl`. Requires `project:update`.

Create a feedback session POST

Reviewers open it with its `embedUrl`, and with a proxy link too when you send `proxy: true`. Fails with 409 when the slug is taken. Requires `feedbackSession:create` and a plan with room for one more active feedback session, and with `feedbackSessionPassword` for a `password`.

GET
/v1/projects/{projectId}/feedback-sessions

Newest first. Requires feedbackSession: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

projectId*string

Query Parameters

limit?integer

Items per page, 1 to 100

Range1 <= value <= 100
Default20
cursor?string

nextCursor from the previous page

Response Body

A page of feedback sessions

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/projects/string/feedback-sessions'
Example Response
{
  "data": [
    {
      "id": "string",
      "projectId": "string",
      "label": "string",
      "dataSession": "string",
      "slug": "string",
      "proxyUrl": "string",
      "password": "string",
      "targetUrl": "string",
      "embedKey": "string",
      "embedUrl": "string",
      "embedScriptUrl": "string",
      "isActive": true,
      "expiresAt": "2019-08-24T14:15:22Z",
      "commentCount": 0,
      "openCommentCount": 0,
      "notificationsMuted": true,
      "status": "active",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextCursor": "string"
}