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 projects GETCreate a project POSTGet a project GETUpdate a project PATCHDelete a project DELETERegenerate the project embed link POST
REST APIProjects

List projects

Get the caller's organization GET

The organization the API key or signed-in member belongs to, with plan usage. Needs no scope. Possible scopes: organization, member, invitation, team, ac, apiKey, project, feedbackSession, comment, notificationDestination, billing, connectedApp.

Create a project POST

Requires `project:create` and a plan with room for one more.

GET
/v1/projects

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

Response Body

A page of projects

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'
Example Response
{
  "data": [
    {
      "id": "string",
      "name": "string",
      "domain": "string",
      "faviconUrl": "string",
      "allowedHosts": [
        "string"
      ],
      "embedKey": "string",
      "embedUrl": "string",
      "embedScriptUrl": "string",
      "screenshotsEnabled": true,
      "toolbarPosition": "top-left",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "nextCursor": "string"
}