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
Get the organization's branding GETGo back to Annoty's branding DELETESet the organization's branding PUTRemove the branding's logo DELETEUpload the branding's logo PUTGet the caller's organization GET
REST APIOrganization

Get the caller's organization

Upload the branding's logo PUT

Replaces the logo: image/png, image/jpeg, image/webp, image/svg+xml, up to 2 MB, sent as multipart/form-data field `file`. Set the branding first. Requires `organization:update` and a plan with `customBranding` (Team).

List projects GET

Newest first. Requires `project:read`.

GET
/v1/organization

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.

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.

Response Body

The organization

application/json
  1. response
  1. response
  2. …
id*string
name*string
slug*string
billingStatus*string

active = paid subscription, trial = inside the free trial, inactive = writes that cost money fail with 402

Value in"active""trial""inactive"
plan*|
Value in"basic""pro""team"null
trialEndsAt*|
Formatdate-time
features*array<>
usage*
caller*|

Who made this request

Example Request
curl -X GET 'https://api.annoty.app/v1/organization'
Example Response
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "billingStatus": "active",
  "plan": "basic",
  "trialEndsAt": "2019-08-24T14:15:22Z",
  "features": [
    "commentExport"
  ],
  "usage": {
    "projects": {
      "used": 0,
      "limit": 0
    },
    "feedbackSessions": {
      "used": 0,
      "limit": 0
    },
    "seats": {
      "used": 0,
      "limit": 0
    }
  },
  "caller": {
    "type": "user",
    "userId": "string",
    "name": "string",
    "roles": [
      "admin"
    ]
  }
}