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 the organization's activity GET
REST APIActivity

List the organization's activity

Unlink a Slack account DELETE

Buttons in Slack stop acting as this member. Session only.

GET
/v1/activity

What happened across the organization, newest first: comments, replies, resolves and reopens from every feedback session, and feedback sessions created, turned off, expired or deleted. Events show up a few seconds after they happen and are kept for 90 days. A deleted feedback session's events go with it, except its deletion. Requires feedbackSession:read and 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.

Query Parameters

limit?integer

Items per page, 1 to 100

Range1 <= value <= 100
Default20
cursor?string

nextCursor from the previous page

projectId?string

Only this project's activity

feedbackSessionId?string

Only this feedback session's activity

Response Body

A page of activity

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/activity'
Example Response
{
  "data": [
    {
      "id": "string",
      "type": "comment.created",
      "occurredAt": "2019-08-24T14:15:22Z",
      "actor": {
        "userId": "string",
        "name": "string"
      },
      "project": {
        "id": "string",
        "name": "string"
      },
      "feedbackSession": {
        "id": "string",
        "label": "string"
      },
      "comment": {
        "id": "string",
        "number": 0,
        "pagePath": "string"
      }
    }
  ],
  "nextCursor": "string"
}