{"openapi":"3.1.0","info":{"title":"Annoty API","version":"1.0.0","description":"Manage projects, feedback sessions, comments and notifications, and read the organization's activity.\n\n**Errors** always look like `{ \"error\": { \"code\", \"message\", \"details\", \"requestId\" } }`. Branch on `code`; `message` may change.\n\n**Pagination**: list endpoints take `limit` and `cursor` and return `{ data, nextCursor }`.\n\n**Rate limits**: 300 requests per minute per key, 100 while the organization is on its trial. Over that you get 429 with `Retry-After`."},"servers":[{"url":"https://api.annoty.app","description":"This server"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"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`."}},"schemas":{"OrganizationBranding":{"type":"object","properties":{"name":{"type":"string","description":"Shown to reviewers next to the logo","example":"Acme Studio"},"url":{"type":["string","null"],"description":"Where the logo and name link to; null for no link","example":"https://acme.example"},"color":{"type":"string","description":"Accent on the toolbar, pins and buttons, `#rrggbb`","example":"#0a7d4f"},"foreground":{"type":"string","description":"Text on `color`, chosen when saving: white or near-black, whichever reads better","example":"#ffffff"},"logoUrl":{"type":["string","null"],"description":"The uploaded logo; null shows Annoty's mark in `color`","example":"https://api.annoty.app/branding/logos/4m7q1c8z3v6b0n5l2p4w9x2k"},"hideFooter":{"type":"boolean","description":"No footer under the widget's panels"},"updatedAt":{"type":"string","format":"date-time"}},"required":["name","url","color","foreground","logoUrl","hideFooter","updatedAt"]},"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","example":"NOT_FOUND"},"message":{"type":"string","example":"Project not found"},"details":{"type":"object","additionalProperties":{}},"requestId":{"type":"string","example":"8c1f2a3b4d5e6f70-VIE"}},"required":["code","message","requestId"]}},"required":["error"]},"BrandingSettings":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":60,"example":"Acme Studio","description":"At most 60 characters"},"url":{"anyOf":[{"type":"null"},{"type":"string"}],"example":"https://acme.example","description":"Where the logo and name link to; null or empty for no link"},"color":{"type":"string","example":"#0a7d4f"},"hideFooter":{"type":"boolean"}},"required":["name","url","color","hideFooter"]},"BrandingLogoUpload":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"PNG, JPEG, WebP or SVG, up to 2 MB"}},"required":["file"]},"Organization":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string","example":"Acme"},"slug":{"type":"string","example":"acme"},"billingStatus":{"type":"string","enum":["active","trial","inactive"],"description":"`active` = paid subscription, `trial` = inside the free trial, `inactive` = writes that cost money fail with 402"},"plan":{"type":["string","null"],"enum":["basic","pro","team",null]},"trialEndsAt":{"type":["string","null"],"format":"date-time"},"features":{"type":"array","items":{"type":"string","enum":["commentExport","customBranding","feedbackSessionPassword","notifications","webhooks","integrations","embed","agents"]}},"usage":{"type":"object","properties":{"projects":{"$ref":"#/components/schemas/Usage"},"feedbackSessions":{"allOf":[{"$ref":"#/components/schemas/Usage"},{"description":"Active feedback sessions"}]},"seats":{"allOf":[{"$ref":"#/components/schemas/Usage"},{"description":"Members plus pending invitations"}]}},"required":["projects","feedbackSessions","seats"]},"caller":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["user"]},"userId":{"type":"string"},"name":{"type":"string"},"roles":{"type":"array","items":{"type":"string","enum":["admin","user"]}}},"required":["type","userId","name","roles"]},{"type":"object","properties":{"type":{"type":"string","enum":["apiKey"]},"apiKeyId":{"type":"string"},"name":{"type":"string","example":"Linear sync"},"scopes":{"type":["object","null"],"additionalProperties":{"type":"array","items":{"type":"string"}},"example":{"project":["read"],"comment":["read","resolve"]}}},"required":["type","apiKeyId","name","scopes"]}],"description":"Who made this request"}},"required":["id","name","slug","billingStatus","plan","trialEndsAt","features","usage","caller"]},"Usage":{"type":"object","properties":{"used":{"type":"integer"},"limit":{"type":["integer","null"],"description":"Null when the organization has no subscription or trial"}},"required":["used","limit"]},"ProjectPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Project"}},"nextCursor":{"type":["string","null"],"description":"Pass as `cursor` for the next page; null on the last page"}},"required":["data","nextCursor"]},"Project":{"type":"object","properties":{"id":{"type":"string","example":"prj_3k9x0c2m7q1z"},"name":{"type":"string","example":"Marketing site"},"domain":{"type":["string","null"],"example":"example.com"},"faviconUrl":{"type":["string","null"],"description":"The site's icon, fetched from `domain` in the background once it's set or changed, and refreshed monthly. Null without a domain, until the icon is found (usually a few seconds after saving), or when the site has none we could fetch.","example":"https://api.annoty.app/favicons/4m7q1c8z3v6b0n5l2p4w9x2k"},"allowedHosts":{"type":"array","items":{"type":"string"},"description":"Where the project embed link works besides `domain`, like staging sites and preview deploys: hosts, or patterns with one `*` in the first label, matching one or more characters of that label.","example":["staging.example.com","*.my-app.pages.dev"]},"embedKey":{"type":"string","description":"The project embed link's key. Add `#annoty=<embedKey>` to the address of any page on `domain` or `allowedHosts` to link reviewers to that page, or put it in the embed script's `data-key` to open the toolbar there without a link, for everyone who loads the page. Anyone who has it can read and post comments on every feedback session it opens, and create new ones. Regenerate it to end every project embed link shared so far, and every `data-key` with it.","example":"rp_4m7q1c8z3v6b0n5l2p4w9x2k"},"embedUrl":{"type":["string","null"],"description":"The project embed link on `domain`, null without one. On a site that loads the embed script, it opens the feedback session the script's `data-session` names and creates it on first use; without `data-session`, the one for the page's host.","example":"https://example.com/#annoty=rp_4m7q1c8z3v6b0n5l2p4w9x2k"},"embedScriptUrl":{"type":"string","description":"The embed script: `<script async src=\"…\" data-session=\"…\"></script>` on every page of the site.","example":"https://api.annoty.app/embed/embed.js"},"screenshotsEnabled":{"type":"boolean","description":"Whether new comments carry a screenshot of what the reviewer saw. Turn it off for a site with customer data on screen: widgets stop taking them, on proxy links and embed links alike, from their next comment. Screenshots taken before stay with their comments.","example":true},"toolbarPosition":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"],"description":"The corner the review toolbar opens in, on proxy links and embed links alike: `top-left`, `top-right`, `bottom-left` or `bottom-right`. A reviewer who moves the toolbar keeps their own corner, and the embed script's `data-position` overrides this on its site.","example":"bottom-right"},"createdAt":{"type":"string","format":"date-time","example":"2026-10-05T09:30:00.000Z"}},"required":["id","name","domain","faviconUrl","allowedHosts","embedKey","embedUrl","embedScriptUrl","screenshotsEnabled","toolbarPosition","createdAt"]},"CreateProject":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"domain":{"type":["string","null"],"minLength":1,"maxLength":253,"description":"The site's domain, e.g. `example.com`. Stored lowercase. Optional; `null` clears it."},"allowedHosts":{"type":"array","items":{"type":"string","minLength":1,"maxLength":253},"maxItems":3,"description":"Up to 3 hosts or patterns, on any site: `staging.example.com`, or one `*` in the first label for preview deploys, like `*.my-app.pages.dev`, `*--my-site.netlify.app` or `my-app-git-*-team.vercel.app`. A `*` matches part of one label only. Stored lowercase; repeats are dropped."},"screenshotsEnabled":{"type":"boolean","description":"Whether new comments carry a screenshot of what the reviewer saw. Defaults to `true`."},"toolbarPosition":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"],"description":"The corner the review toolbar opens in. Defaults to `bottom-right`."}},"required":["name"]},"UpdateProject":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"domain":{"type":["string","null"],"minLength":1,"maxLength":253,"description":"The site's domain, e.g. `example.com`. Stored lowercase. Optional; `null` clears it."},"allowedHosts":{"type":"array","items":{"type":"string","minLength":1,"maxLength":253},"maxItems":3,"description":"Up to 3 hosts or patterns, on any site: `staging.example.com`, or one `*` in the first label for preview deploys, like `*.my-app.pages.dev`, `*--my-site.netlify.app` or `my-app-git-*-team.vercel.app`. A `*` matches part of one label only. Stored lowercase; repeats are dropped."},"screenshotsEnabled":{"type":"boolean","description":"Whether new comments carry a screenshot of what the reviewer saw. Defaults to `true`."},"toolbarPosition":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"],"description":"The corner the review toolbar opens in. Defaults to `bottom-right`."}}},"FeedbackSessionPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FeedbackSession"}},"nextCursor":{"type":["string","null"],"description":"Pass as `cursor` for the next page; null on the last page"}},"required":["data","nextCursor"]},"FeedbackSession":{"type":"object","properties":{"id":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"projectId":{"type":"string","example":"prj_3k9x0c2m7q1z"},"label":{"type":"string","example":"Homepage redesign"},"dataSession":{"type":["string","null"],"description":"Set when the project embed link created this feedback session: the embed script's `data-session`, or the page's host without one, slugified. The project embed link opens this feedback session again wherever the embed script names it.","example":"feature-login"},"slug":{"type":["string","null"],"description":"The proxy link's subdomain on annoty.site; null without a proxy link","example":"homepage-redesign-k3x9m2qa"},"proxyUrl":{"type":["string","null"],"description":"The proxy link: the target site on annoty.site with the comment toolbar on top. Nothing to install on the site. Anyone who has it can read and post comments. Null when the feedback session has none (`proxy: false`): reviewers open it with `embedUrl` only.","example":"https://homepage-redesign-k3x9m2qa.annoty.site"},"password":{"type":["string","null"],"description":"The proxy link asks for it before it shows the site, once per browser; null when it doesn't, or when there's no proxy link. Members who open the feedback session from the dashboard skip it. The embed link never asks for it. An empty string when it can't be read back: set a new one.","example":"spring-review"},"targetUrl":{"type":"string","example":"https://staging.example.com"},"embedKey":{"type":"string","description":"The embed link's key. Put it in the embed script's `data-key` to open the toolbar on the target site without a link, for everyone who loads the page: that makes it public on the page. Anyone who has it can read and post comments.","example":"rk_9x2k4m7q1c8z3v6b0n5l2p4w"},"embedUrl":{"type":"string","description":"The embed link: the target URL with an embed key in its fragment, which opens the comment toolbar on the site itself. Works once the site loads the embed script (`embedScriptUrl`), including behind a login. Like `proxyUrl`, anyone who has it can read and post comments.","example":"https://staging.example.com/#annoty=rk_9x2k4m7q1c8z3v6b0n5l2p4w"},"embedScriptUrl":{"type":"string","description":"The embed script, which the target site loads on every page for `embedUrl` to work: `<script async src=\"…\"></script>`. The same for every feedback session.","example":"https://api.annoty.app/embed/embed.js"},"isActive":{"type":"boolean"},"expiresAt":{"type":["string","null"],"format":"date-time","example":"2026-11-01T00:00:00.000Z"},"commentCount":{"type":"integer","description":"Comment threads; replies aren't counted","example":12},"openCommentCount":{"type":"integer","example":3},"notificationsMuted":{"type":"boolean","description":"The project's notification destinations skip this feedback session; its own destinations still get its events"},"status":{"type":"string","enum":["active","inactive","expired"],"description":"`inactive` when `isActive` is false, `expired` once `expiresAt` has passed. Only `active` feedback sessions open and count toward the plan's `maxFeedbackSessions`."},"createdAt":{"type":"string","format":"date-time","example":"2026-10-05T09:30:00.000Z"}},"required":["id","projectId","label","dataSession","slug","proxyUrl","password","targetUrl","embedKey","embedUrl","embedScriptUrl","isActive","expiresAt","commentCount","openCommentCount","notificationsMuted","status","createdAt"]},"FeedbackSessionWithProjectPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FeedbackSessionWithProject"}},"nextCursor":{"type":["string","null"],"description":"Pass as `cursor` for the next page; null on the last page"}},"required":["data","nextCursor"]},"FeedbackSessionWithProject":{"allOf":[{"$ref":"#/components/schemas/FeedbackSession"},{"type":"object","properties":{"project":{"type":"object","properties":{"id":{"type":"string","example":"prj_3k9x0c2m7q1z"},"name":{"type":"string","example":"Marketing site"},"faviconUrl":{"type":["string","null"],"description":"The project's site icon, as on the project","example":"https://api.annoty.app/favicons/4m7q1c8z3v6b0n5l2p4w9x2k"}},"required":["id","name","faviconUrl"]}},"required":["project"]}]},"CreateFeedbackSession":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":100},"targetUrl":{"type":"string","maxLength":2048,"format":"uri","description":"The site reviewers see, with the comment widget added","example":"https://staging.example.com"},"proxy":{"type":"boolean","default":false,"description":"true gives the feedback session a proxy link on annoty.site. Left out, reviewers open it with its embed link only; a proxy link can be added later."},"slug":{"type":"string","minLength":3,"maxLength":63,"description":"The proxy link's subdomain on annoty.site, with `proxy: true`: 3 to 63 lowercase letters, digits and hyphens, unique across Annoty. Can't be changed once set. Defaults to the label plus 8 random characters; a custom slug is easier to guess.","example":"homepage-redesign-k3x9m2qa"},"expiresAt":{"type":["string","null"],"format":"date-time","description":"The proxy link and the embed link stop working after this. Null for never.","example":"2026-11-01T00:00:00.000Z"},"password":{"type":"string","minLength":6,"maxLength":100,"description":"What the proxy link asks for: 6 to 100 characters, trimmed. Needs a proxy link and a plan with `feedbackSessionPassword`.","example":"spring-review"}},"required":["label","targetUrl"]},"UpdateFeedbackSession":{"type":"object","properties":{"label":{"type":"string","minLength":1,"maxLength":100},"targetUrl":{"type":"string","maxLength":2048,"format":"uri","description":"The site reviewers see, with the comment widget added","example":"https://staging.example.com"},"isActive":{"type":"boolean","description":"false turns the proxy link and the embed link off and keeps the comments"},"expiresAt":{"type":["string","null"],"format":"date-time","description":"The proxy link and the embed link stop working after this. Null for never.","example":"2026-11-01T00:00:00.000Z"},"notificationsMuted":{"type":"boolean"},"proxy":{"type":"boolean","description":"true adds a proxy link, with `slug` or a random one; it's a no-op when there is one. false removes it with its password: its slug stays with your organization for 60 days, so adding it back in that time can take the same slug. The embed link works either way."},"slug":{"type":"string","minLength":3,"maxLength":63,"description":"The new proxy link's subdomain, with `proxy: true` on a feedback session without one. A proxy link's slug can't be changed.","example":"homepage-redesign-k3x9m2qa"},"password":{"type":["string","null"],"minLength":6,"maxLength":100,"description":"A new password asks every browser for it again. Null removes it, which every plan can do.","example":"spring-review"}},"additionalProperties":false},"FeedbackSessionSiteList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FeedbackSessionSite"}}},"required":["data"]},"FeedbackSessionSite":{"type":"object","properties":{"origin":{"type":"string","description":"The page's origin, port included. For `proxy`, the proxy link's","example":"https://staging.example.com"},"method":{"type":"string","enum":["proxy","embed"],"description":"`embed`: a site that loads the embed script; `proxy`: the proxy link"},"firstOpenedAt":{"type":"string","format":"date-time","example":"2026-10-05T09:30:00.000Z"},"lastOpenedAt":{"type":"string","format":"date-time","example":"2026-10-07T14:02:00.000Z"}},"required":["origin","method","firstOpenedAt","lastOpenedAt"]},"CommentPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Comment"}},"nextCursor":{"type":["string","null"],"description":"Pass as `cursor` for the next page; null on the last page"}},"required":["data","nextCursor"]},"Comment":{"type":"object","properties":{"id":{"type":"string","example":"com_3k9x0c"},"feedbackSessionId":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"number":{"type":["integer","null"],"description":"The pin number reviewers see, unique within the feedback session","example":12},"pagePath":{"type":"string","example":"/pricing"},"selector":{"type":"string","description":"CSS selector of the element the pin is on","example":"main > section:nth-of-type(2) h2"},"body":{"type":"string","example":"This heading wraps badly"},"authorName":{"type":"string","example":"Sam"},"authorId":{"type":["string","null"],"description":"Anonymous id of the reviewer's browser: the same reviewer keeps it across comments. Null on old comments."},"authorUserId":{"type":["string","null"],"description":"The org member's user id when they commented signed in on the feedback session; null for reviewers"},"authorApiKeyId":{"type":["string","null"],"description":"The API key's id when it came through the API with a key, e.g. an agent's reply over MCP. Widgets show it as from the team, like a member's"},"status":{"type":"string","enum":["open","resolved"]},"resolvedAt":{"type":["string","null"],"format":"date-time"},"resolvedBy":{"type":["string","null"],"description":"A reviewer's `authorId`, `user:<id>` when an org member resolved it (in the widget or through the API), or `apiKey:<id>`"},"resolvedByName":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"},"context":{"$ref":"#/components/schemas/CommentContext"},"replies":{"type":"array","items":{"$ref":"#/components/schemas/CommentReply"},"description":"Oldest first"}},"required":["id","feedbackSessionId","number","pagePath","selector","body","authorName","authorId","authorUserId","authorApiKeyId","status","resolvedAt","resolvedBy","resolvedByName","createdAt","updatedAt","context","replies"]},"CommentContext":{"type":["object","null"],"properties":{"pageUrl":{"type":"string","description":"The address the reviewer had open, query and fragment included. On a proxy link it's on the feedback session's annoty.site host; `pagePath` is the same page on `targetUrl`","example":"https://spring-launch-4k9x0c2m.annoty.site/pricing?plan=team"},"elementText":{"type":"string","description":"The element's visible text, whitespace collapsed, up to 500 characters. Search the code for it to find the element","example":"Plans for every team"},"elementHtml":{"type":"string","description":"The element's HTML, cut off at 1000 characters","example":"<h2 class=\"pricing-title\">Plans for every team</h2>"},"viewport":{"type":"object","properties":{"width":{"type":"integer"},"height":{"type":"integer"}},"required":["width","height"],"description":"The browser window's size in CSS pixels","example":{"width":390,"height":844}},"userAgent":{"type":"string","example":"Mozilla/5.0 (iPhone; CPU iPhone OS 19_0 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/19.0 Mobile/15E148 Safari/604.1"},"screenshot":{"$ref":"#/components/schemas/CommentScreenshot"}},"required":["pageUrl","elementText","elementHtml","viewport","userAgent","screenshot"],"description":"What the reviewer's browser showed when they pinned the comment. Null on older comments"},"CommentScreenshot":{"type":["object","null"],"properties":{"url":{"type":"string","description":"The JPEG. Fetch it with the same credentials as this comment: `GET …/comments/{commentId}/screenshot`","example":"https://api.annoty.app/v1/feedback-sessions/fbs_8d2k1m0x7q3c/comments/com_3k9x0c/screenshot"},"width":{"type":"integer","example":1600},"height":{"type":"integer","example":1000},"element":{"type":["object","null"],"properties":{"x":{"type":"integer"},"y":{"type":"integer"},"width":{"type":"integer"},"height":{"type":"integer"}},"required":["x","y","width","height"],"description":"The element's visible part in the image's pixels, also outlined in the image. Null when it was out of view","example":{"x":412,"y":236,"width":776,"height":58}}},"required":["url","width","height","element"],"description":"The reviewer's viewport when they pinned the comment, scaled to at most 1600 pixels on the long side, with the element outlined. Null when there's none: older comments, a browser that couldn't capture the page, or a reviewer who left it out"},"CommentReply":{"type":"object","properties":{"id":{"type":"string","example":"com_7f2k9q"},"body":{"type":"string","example":"Agreed, and on mobile too"},"authorName":{"type":"string","example":"Dana"},"authorId":{"type":["string","null"]},"authorUserId":{"type":["string","null"]},"authorApiKeyId":{"type":["string","null"],"description":"The API key's id when it came through the API with a key, e.g. an agent's reply over MCP. Widgets show it as from the team, like a member's"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":["string","null"],"format":"date-time"}},"required":["id","body","authorName","authorId","authorUserId","authorApiKeyId","createdAt","updatedAt"]},"UpdateComment":{"type":"object","properties":{"status":{"type":"string","enum":["open","resolved"]}},"required":["status"],"additionalProperties":false},"CreateReply":{"type":"object","properties":{"body":{"type":"string","minLength":1,"maxLength":5000}},"required":["body"],"additionalProperties":false,"example":{"body":"Fixed: the heading no longer wraps on phones."}},"SentToAgent":{"type":"object","properties":{"deliveryId":{"type":"string","description":"The send in the agent's delivery log","example":"dlv_3k9x0c2m7q1zp4a8"},"status":{"type":"string","enum":["delivered","pending","failed"],"description":"`delivered`: the run started. `pending`: the first attempt failed and Annoty tries again. `failed`: it can't work as set up, see `error`"},"runUrl":{"type":["string","null"],"description":"Where to watch the run: the Claude Code session, or the repository's Actions tab. Null until it's delivered","example":"https://claude.ai/code/session_01HJKLMNOPQRSTUVWXYZ"},"error":{"type":["string","null"],"description":"Why the first attempt failed"}},"required":["deliveryId","status","runUrl","error"]},"SendToAgent":{"type":"object","properties":{"destinationId":{"type":"string","minLength":1,"description":"The coding agent: one of the project's notification destinations of type `claude_code` or `github_actions`","example":"dst_3k9x0c2m7q1z"}},"required":["destinationId"],"additionalProperties":false},"NotificationDestinationPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NotificationDestination"}},"nextCursor":{"type":["string","null"],"description":"Pass as `cursor` for the next page; null on the last page"}},"required":["data","nextCursor"]},"NotificationDestination":{"type":"object","properties":{"id":{"type":"string","example":"dst_3k9x0c2m7q1z"},"projectId":{"type":"string","example":"prj_3k9x0c2m7q1z"},"feedbackSessionIds":{"type":"array","items":{"type":"string"},"description":"The feedback sessions whose events it gets. Empty: every feedback session in the project that isn't muted","example":["fbs_3k9x0c2m7q1z"]},"type":{"type":"string","enum":["discord","slack","webhook","claude_code","github_actions","cursor"],"description":"`discord`: a Discord channel's webhook. `slack`: a channel in a Slack workspace connected with `POST /slack/install`. `webhook`: any https URL, signed the Standard Webhooks way. `claude_code`: a Claude Code scheduled task's API trigger. `github_actions`: `repository_dispatch` on a GitHub repository, for Claude Code's or Codex's GitHub Action. `cursor`: a Cursor cloud agent on a GitHub repository. The last three are coding agents: `POST …/comments/{commentId}/send-to-agent` sends them a comment"},"name":{"type":"string","example":"#design-feedback"},"urlPreview":{"type":"string","description":"The URL without its secret part: Discord's webhook id; a webhook's host, its path's first segment when more follow and the last 4 characters of the rest (`n8n.acme.dev/webhook-test/…f3a9`); a Claude Code trigger's id or a GitHub repository. The URL and any token are never returned","example":"discord.com/api/webhooks/1234567890123456789/…"},"events":{"type":"array","items":{"type":"string","enum":["comment.created","comment.replied","comment.resolved","comment.reopened","feedback_session.created","feedback_session.deactivated","feedback_session.expired","feedback_session.deleted"]},"description":"The activity events this receives. Empty for coding agents (`claude_code`, `github_actions`): they get only the comments a member sends them","example":["comment.created"]},"enabled":{"type":"boolean"},"lastError":{"type":["string","null"],"description":"Why the last delivery failed. A webhook deleted on Discord's side also sets `enabled` to false"},"lastErrorAt":{"type":["string","null"],"format":"date-time"},"hasAnnotyApiKey":{"type":"boolean","description":"`cursor`: an Annoty API key is stored for the agent's MCP server, so it can read the whole comment and reply. Always false for other types"},"createdAt":{"type":"string","format":"date-time"}},"required":["id","projectId","feedbackSessionIds","type","name","urlPreview","events","enabled","lastError","lastErrorAt","hasAnnotyApiKey","createdAt"]},"CreatedNotificationDestination":{"allOf":[{"$ref":"#/components/schemas/NotificationDestination"},{"type":"object","properties":{"secret":{"type":["string","null"],"description":"`webhook`: the signing secret. Null for every other type","example":"whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"}},"required":["secret"]}]},"CreateNotificationDestination":{"oneOf":[{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"events":{"type":"array","items":{"type":"string","enum":["comment.created","comment.replied","comment.resolved","comment.reopened","feedback_session.created","feedback_session.deactivated","feedback_session.expired","feedback_session.deleted"]},"minItems":1,"default":["comment.created"],"description":"The activity events this receives","example":["comment.created"]},"feedbackSessionIds":{"type":"array","items":{"type":"string"},"maxItems":100,"default":[],"description":"Only these feedback sessions' events, muted or not. Empty: every feedback session in the project that isn't muted. Fixed once created; deleting the last of them deletes the destination","example":["fbs_3k9x0c2m7q1z"]},"enabled":{"type":"boolean","default":true},"type":{"type":"string","enum":["discord"]},"url":{"type":"string","description":"Discord: channel settings → Integrations → Webhooks → Copy Webhook URL","example":"https://discord.com/api/webhooks/1234567890123456789/abc…"}},"required":["name","type","url"]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"events":{"type":"array","items":{"type":"string","enum":["comment.created","comment.replied","comment.resolved","comment.reopened","feedback_session.created","feedback_session.deactivated","feedback_session.expired","feedback_session.deleted"]},"minItems":1,"default":["comment.created","comment.replied","comment.resolved","comment.reopened"],"description":"The activity events this receives","example":["comment.created"]},"feedbackSessionIds":{"type":"array","items":{"type":"string"},"maxItems":100,"default":[],"description":"Only these feedback sessions' events, muted or not. Empty: every feedback session in the project that isn't muted. Fixed once created; deleting the last of them deletes the destination","example":["fbs_3k9x0c2m7q1z"]},"enabled":{"type":"boolean","default":true},"type":{"type":"string","enum":["slack"]},"teamId":{"type":"string","minLength":2,"maxLength":32,"description":"The connected workspace: `GET /slack/workspaces`","example":"T0123ABCD"},"channelId":{"type":"string","minLength":2,"maxLength":32,"description":"The channel: `GET /slack/workspaces/{teamId}/channels`. A private one needs @Annoty invited first","example":"C0123ABCD"}},"required":["type","teamId","channelId"]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"events":{"type":"array","items":{"type":"string","enum":["comment.created","comment.replied","comment.resolved","comment.reopened","feedback_session.created","feedback_session.deactivated","feedback_session.expired","feedback_session.deleted"]},"minItems":1,"default":["comment.created"],"description":"The activity events this receives","example":["comment.created"]},"feedbackSessionIds":{"type":"array","items":{"type":"string"},"maxItems":100,"default":[],"description":"Only these feedback sessions' events, muted or not. Empty: every feedback session in the project that isn't muted. Fixed once created; deleting the last of them deletes the destination","example":["fbs_3k9x0c2m7q1z"]},"enabled":{"type":"boolean","default":true},"type":{"type":"string","enum":["webhook"]},"url":{"type":"string","description":"Any https URL on a public host. Annoty POSTs each event there as JSON, signed","example":"https://hooks.zapier.com/hooks/catch/123456/abcdef/"}},"required":["name","type","url"]},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"enabled":{"type":"boolean","default":true},"type":{"type":"string","enum":["claude_code"]},"url":{"type":"string","description":"The scheduled task's API trigger: claude.ai/code/routines → the task → Edit → API → Fire URL","example":"https://api.anthropic.com/v1/claude_code/routines/trig_01ABCDEFGHJKLMNOPQRSTUVW/fire"},"token":{"type":"string","minLength":1,"maxLength":500,"description":"The task's API token (Generate token, shown once). Stored encrypted, never returned","example":"sk-ant-oat01-…"}},"required":["name","type","url","token"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"enabled":{"type":"boolean","default":true},"type":{"type":"string","enum":["github_actions"]},"url":{"type":"string","description":"The repository whose workflows run on `repository_dispatch` with type `annoty-comment`","example":"https://github.com/acme/website"},"token":{"type":"string","minLength":1,"maxLength":500,"description":"A fine-grained GitHub token with Contents read and write on the repository, which `repository_dispatch` needs. Stored encrypted, never returned","example":"github_pat_…"}},"required":["name","type","url","token"],"additionalProperties":false},{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"enabled":{"type":"boolean","default":true},"type":{"type":"string","enum":["cursor"]},"url":{"type":"string","description":"The repository the agent works on, which Cursor reaches through its GitHub integration","example":"https://github.com/acme/website"},"token":{"type":"string","minLength":1,"maxLength":500,"description":"A Cursor API key (Cursor dashboard → API Keys), which launches the cloud agent. Stored encrypted, never returned","example":"key_…"},"annotyApiKey":{"type":"string","minLength":1,"maxLength":500,"description":"`cursor`: an API key of this organization with `comment:read` and `comment:create`, which the agent's MCP server connection uses to read the comment and reply. Its replies show under the key's name. Stored encrypted, never returned","example":"annoty_…"}},"required":["name","type","url","token"],"additionalProperties":false}]},"UpdateNotificationDestination":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100},"url":{"type":"string","description":"A URL the destination's type takes: Discord's webhook URL for `discord`, any public https URL for `webhook`, the fire URL for `claude_code`, the repository for `github_actions` and `cursor`"},"annotyApiKey":{"type":["string","null"],"description":"`cursor` only: a new Annoty API key for the agent's MCP server, or null to remove it"},"token":{"type":"string","description":"Coding agents only: a new token, checked against the destination's type like `url`"},"events":{"type":"array","items":{"type":"string","enum":["comment.created","comment.replied","comment.resolved","comment.reopened","feedback_session.created","feedback_session.deactivated","feedback_session.expired","feedback_session.deleted"]},"minItems":1,"description":"Not for coding agents, which get no events","example":["comment.created"]},"enabled":{"type":"boolean","description":"Turning a destination back on clears `lastError`"}},"additionalProperties":false},"NotificationDestinationTestResult":{"type":"object","properties":{"delivered":{"type":"boolean"},"deliveryId":{"type":"string","description":"The test in the destination's delivery log","example":"dlv_3k9x0c2m7q1zp4a8"},"error":{"type":["string","null"],"description":"Why it wasn't delivered; also stored as the destination's `lastError`"},"destination":{"$ref":"#/components/schemas/NotificationDestination"}},"required":["delivered","deliveryId","error","destination"]},"NotificationDestinationSecret":{"type":"object","properties":{"secret":{"type":"string","description":"The webhook's signing secret: keep it to check `webhook-signature`. `GET /notification-destinations/{destinationId}/secret` returns it again","example":"whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"}},"required":["secret"]},"RotatedNotificationDestinationSecret":{"type":"object","properties":{"secret":{"type":"string","description":"The webhook's signing secret: keep it to check `webhook-signature`. `GET /notification-destinations/{destinationId}/secret` returns it again","example":"whsec_MfKQ9r8GKYqrTwjUPD8ILPZIo2LaLaSw"},"destination":{"$ref":"#/components/schemas/NotificationDestination"}},"required":["secret","destination"]},"NotificationPreferences":{"type":"object","properties":{"projectId":{"type":"string","example":"prj_3k9x0c2m7q1z"},"email":{"type":"boolean","description":"Email notifications of this project's activity, grouped into one email about 10 minutes after the first event. Never about your own actions"},"events":{"type":"array","items":{"type":"string","enum":["comment.created","comment.replied","comment.resolved","comment.reopened","feedback_session.created","feedback_session.deactivated","feedback_session.expired","feedback_session.deleted"]},"minItems":1,"description":"The activity events this receives","example":["comment.created"]}},"required":["projectId","email","events"]},"UpdateNotificationPreferences":{"type":"object","properties":{"email":{"type":"boolean","description":"Email notifications of this project's activity, grouped into one email about 10 minutes after the first event. Never about your own actions"},"events":{"type":"array","items":{"type":"string","enum":["comment.created","comment.replied","comment.resolved","comment.reopened","feedback_session.created","feedback_session.deactivated","feedback_session.expired","feedback_session.deleted"]},"minItems":1,"description":"The activity events this receives","example":["comment.created"]}},"required":["email","events"]},"NotificationDeliveryPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NotificationDelivery"}},"nextCursor":{"type":["string","null"],"description":"Pass as `cursor` for the next page; null on the last page"}},"required":["data","nextCursor"]},"NotificationDelivery":{"type":"object","properties":{"id":{"type":"string","example":"dlv_3k9x0c2m7q1zp4a8"},"destinationId":{"type":"string","example":"dst_3k9x0c2m7q1z"},"eventId":{"type":"string","description":"The activity event's id, also a webhook's `webhook-id` header. A test gets its own","example":"evt_4k9x0c2m7q1d8f3b"},"eventType":{"type":["string","null"],"enum":["comment.created","comment.replied","comment.resolved","comment.reopened","feedback_session.created","feedback_session.deactivated","feedback_session.expired","feedback_session.deleted",null],"description":"Null for Discord's test message, which is no event, and for a comment sent to a coding agent"},"test":{"type":"boolean","description":"Sent from \"Send test\""},"status":{"type":"string","enum":["pending","delivered","failed"],"description":"`pending`: being tried, next at `nextAttemptAt`. `failed`: every attempt failed, one failed in a way a retry can't fix, or the destination was turned off. A failed delivery is tried 8 times over about a day"},"attemptCount":{"type":"integer","example":1},"nextAttemptAt":{"type":["string","null"],"format":"date-time"},"lastStatusCode":{"type":["integer","null"],"description":"What the last attempt got back; null without a response","example":204},"lastError":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","destinationId","eventId","eventType","test","status","attemptCount","nextAttemptAt","lastStatusCode","lastError","createdAt","updatedAt"]},"NotificationDeliveryDetail":{"allOf":[{"$ref":"#/components/schemas/NotificationDelivery"},{"type":"object","properties":{"body":{"type":"string","description":"The request body as sent, JSON. Every attempt sends the same"},"attempts":{"type":"array","items":{"$ref":"#/components/schemas/NotificationDeliveryAttempt"}}},"required":["body","attempts"]}]},"NotificationDeliveryAttempt":{"type":"object","properties":{"attempt":{"type":"integer","example":1},"statusCode":{"type":["integer","null"],"description":"Null when there was no response: a network error or a timeout","example":502},"error":{"type":["string","null"]},"responseBody":{"type":["string","null"],"description":"The response body's first 1,024 characters"},"durationMs":{"type":"integer"},"createdAt":{"type":"string","format":"date-time"}},"required":["attempt","statusCode","error","responseBody","durationMs","createdAt"]},"SlackInstallStarted":{"type":"object","properties":{"authorizeUrl":{"type":"string"}},"required":["authorizeUrl"]},"StartSlackInstall":{"type":"object","properties":{"projectId":{"type":["string","null"],"description":"The project to return to","example":"prj_3k9x0c2m7q1z"}},"required":["projectId"],"additionalProperties":false},"SlackInstallCompleted":{"type":"object","properties":{"teamId":{"type":"string"},"teamName":{"type":"string"},"projectId":{"type":["string","null"],"description":"The project to return to","example":"prj_3k9x0c2m7q1z"}},"required":["teamId","teamName","projectId"]},"CompleteSlackInstall":{"type":"object","properties":{"code":{"type":"string","minLength":1},"state":{"type":"string","minLength":1}},"required":["code","state"],"additionalProperties":false},"SlackWorkspaceList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SlackWorkspace"}}},"required":["data"]},"SlackWorkspace":{"type":"object","properties":{"teamId":{"type":"string","example":"T0123ABCD"},"teamName":{"type":"string","example":"Acme"},"installedBy":{"type":["string","null"],"description":"Who connected it, null once they've deleted their account","example":"Sam Rivera"},"channelCount":{"type":"integer","description":"Slack channels bound to the organization's projects","example":2},"createdAt":{"type":"string","format":"date-time"}},"required":["teamId","teamName","installedBy","channelCount","createdAt"]},"SlackChannelList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SlackChannel"}},"nextCursor":{"type":["string","null"]}},"required":["data","nextCursor"]},"SlackChannel":{"type":"object","properties":{"id":{"type":"string","example":"C0123ABCD"},"name":{"type":"string","example":"design-feedback"},"isPrivate":{"type":"boolean"}},"required":["id","name","isPrivate"]},"SlackUserLink":{"type":"object","properties":{"teamId":{"type":"string","example":"T0123ABCD"},"teamName":{"type":"string","example":"Acme"},"slackUserId":{"type":"string","example":"U0123ABCD"},"slackUserName":{"type":"string","example":"sam"}},"required":["teamId","teamName","slackUserId","slackUserName"]},"LinkSlackUser":{"type":"object","properties":{"token":{"type":"string","minLength":1}},"required":["token"],"additionalProperties":false},"SlackUserLinkList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SlackUserLink"}}},"required":["data"]},"ActivityPage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Activity"}},"nextCursor":{"type":["string","null"],"description":"Pass as `cursor` for the next page; null on the last page"}},"required":["data","nextCursor"]},"Activity":{"type":"object","properties":{"id":{"type":"string","example":"evt_4k9x0c2m7q1d8f3b"},"type":{"type":"string","enum":["comment.created","comment.replied","comment.resolved","comment.reopened","feedback_session.created","feedback_session.deactivated","feedback_session.expired","feedback_session.deleted"]},"occurredAt":{"type":"string","format":"date-time"},"actor":{"type":"object","properties":{"userId":{"type":["string","null"],"description":"Set when an org member did it"},"name":{"type":["string","null"],"description":"The reviewer's typed name, the member's name or the API key's name; null for what nobody did, like `feedback_session.expired`","example":"Sam"}},"required":["userId","name"]},"project":{"type":"object","properties":{"id":{"type":"string","example":"prj_8d2k1m0x7q3c"},"name":{"type":"string","example":"Marketing site"}},"required":["id","name"]},"feedbackSession":{"type":"object","properties":{"id":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"label":{"type":"string","example":"Homepage review"}},"required":["id","label"]},"comment":{"type":["object","null"],"properties":{"id":{"type":"string","example":"com_3k9x0c"},"number":{"type":["integer","null"],"example":12},"pagePath":{"type":"string","example":"/pricing"}},"required":["id","number","pagePath"],"description":"`comment.*`: the thread, also the one `comment.replied` answered. No text: list the feedback session's comments for that"}},"required":["id","type","occurredAt","actor","project","feedbackSession","comment"]}},"parameters":{}},"paths":{"/v1/organization/branding":{"get":{"operationId":"getOrganizationBranding","summary":"Get the organization's branding","description":"404 when it has none, so reviewers see Annoty's. Reviewers see a stored branding only while the plan includes `customBranding` (Team).","tags":["Organization"],"responses":{"200":{"description":"The organization's branding","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationBranding"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"updateOrganizationBranding","summary":"Set the organization's branding","description":"Creates or replaces the name, link, color and footer setting; the logo has its own endpoint. Requires `organization:update` and a plan with `customBranding` (Team).","tags":["Organization"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BrandingSettings"}}}},"responses":{"200":{"description":"The organization's branding","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationBranding"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"deleteOrganizationBranding","summary":"Go back to Annoty's branding","description":"Deletes the branding and its logo. Works on every plan. Requires `organization:update`.","tags":["Organization"],"responses":{"204":{"description":"Deleted, or there was none"},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organization/branding/logo":{"put":{"operationId":"uploadOrganizationBrandingLogo","summary":"Upload the branding's logo","description":"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).","tags":["Organization"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/BrandingLogoUpload"}}}},"responses":{"200":{"description":"The organization's branding","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationBranding"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"deleteOrganizationBrandingLogo","summary":"Remove the branding's logo","description":"Reviewers see Annoty's mark in the branding's color instead. Requires `organization:update`.","tags":["Organization"],"responses":{"200":{"description":"The organization's branding","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationBranding"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/organization":{"get":{"operationId":"getOrganization","summary":"Get the caller's organization","description":"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.","tags":["Organization"],"responses":{"200":{"description":"The organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/projects":{"get":{"operationId":"listProjects","summary":"List projects","description":"Newest first. Requires `project:read`.","tags":["Projects"],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Items per page, 1 to 100"},"required":false,"description":"Items per page, 1 to 100","name":"limit","in":"query"},{"schema":{"type":"string","description":"`nextCursor` from the previous page"},"required":false,"description":"`nextCursor` from the previous page","name":"cursor","in":"query"}],"responses":{"200":{"description":"A page of projects","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectPage"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"createProject","summary":"Create a project","description":"Requires `project:create` and a plan with room for one more.","tags":["Projects"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProject"}}}},"responses":{"201":{"description":"The created project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/projects/{projectId}":{"get":{"operationId":"getProject","summary":"Get a project","description":"Requires `project:read`.","tags":["Projects"],"parameters":[{"schema":{"type":"string","example":"prj_3k9x0c2m7q1z"},"required":true,"name":"projectId","in":"path"}],"responses":{"200":{"description":"The project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"operationId":"updateProject","summary":"Update a project","description":"Only the fields you send change. Requires `project:update`.","tags":["Projects"],"parameters":[{"schema":{"type":"string","example":"prj_3k9x0c2m7q1z"},"required":true,"name":"projectId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProject"}}}},"responses":{"200":{"description":"The updated project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"deleteProject","summary":"Delete a project","description":"Fails with 409 while the project still has feedback sessions. Requires `project:delete`.","tags":["Projects"],"parameters":[{"schema":{"type":"string","example":"prj_3k9x0c2m7q1z"},"required":true,"name":"projectId","in":"path"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with the resource's current state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/projects/{projectId}/embed-key":{"post":{"operationId":"regenerateProjectEmbedKey","summary":"Regenerate the project embed link","description":"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`.","tags":["Projects"],"parameters":[{"schema":{"type":"string","example":"prj_3k9x0c2m7q1z"},"required":true,"name":"projectId","in":"path"}],"responses":{"200":{"description":"The project with its new embed key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/projects/{projectId}/feedback-sessions":{"get":{"operationId":"listFeedbackSessions","summary":"List a project's feedback sessions","description":"Newest first. Requires `feedbackSession:read`.","tags":["Feedback sessions"],"parameters":[{"schema":{"type":"string","example":"prj_3k9x0c2m7q1z"},"required":true,"name":"projectId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Items per page, 1 to 100"},"required":false,"description":"Items per page, 1 to 100","name":"limit","in":"query"},{"schema":{"type":"string","description":"`nextCursor` from the previous page"},"required":false,"description":"`nextCursor` from the previous page","name":"cursor","in":"query"}],"responses":{"200":{"description":"A page of feedback sessions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackSessionPage"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"createFeedbackSession","summary":"Create a feedback session","description":"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`.","tags":["Feedback sessions"],"parameters":[{"schema":{"type":"string","example":"prj_3k9x0c2m7q1z"},"required":true,"name":"projectId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFeedbackSession"}}}},"responses":{"201":{"description":"The created feedback session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackSession"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with the resource's current state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/feedback-sessions":{"get":{"operationId":"listOrganizationFeedbackSessions","summary":"List the organization's feedback sessions","description":"Every project's feedback sessions, newest first, each with its project's name. Requires `feedbackSession:read`.","tags":["Feedback sessions"],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Items per page, 1 to 100"},"required":false,"description":"Items per page, 1 to 100","name":"limit","in":"query"},{"schema":{"type":"string","description":"`nextCursor` from the previous page"},"required":false,"description":"`nextCursor` from the previous page","name":"cursor","in":"query"},{"schema":{"type":"string","description":"Only this project's feedback sessions"},"required":false,"description":"Only this project's feedback sessions","name":"projectId","in":"query"},{"schema":{"type":"string","enum":["active","inactive","expired"],"description":"Only feedback sessions with this `status`"},"required":false,"description":"Only feedback sessions with this `status`","name":"status","in":"query"},{"schema":{"type":"string","description":"`true`: only feedback sessions with open comment threads; `false`: only those without"},"required":false,"description":"`true`: only feedback sessions with open comment threads; `false`: only those without","name":"hasOpenComments","in":"query"}],"responses":{"200":{"description":"A page of feedback sessions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackSessionWithProjectPage"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/feedback-sessions/{feedbackSessionId}":{"get":{"operationId":"getFeedbackSession","summary":"Get a feedback session","description":"Requires `feedbackSession:read`.","tags":["Feedback sessions"],"parameters":[{"schema":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"required":true,"name":"feedbackSessionId","in":"path"}],"responses":{"200":{"description":"The feedback session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackSession"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"operationId":"updateFeedbackSession","summary":"Update a feedback session","description":"Only the fields you send change. `proxy` adds or removes the proxy link; a proxy link's slug can't change. Turning a feedback session back on needs room in the plan's `maxFeedbackSessions`, and setting a `password` a proxy link and a plan with `feedbackSessionPassword`. Fails with 409 when a new proxy link's slug is taken. Requires `feedbackSession:update`.","tags":["Feedback sessions"],"parameters":[{"schema":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"required":true,"name":"feedbackSessionId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFeedbackSession"}}}},"responses":{"200":{"description":"The updated feedback session","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackSession"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with the resource's current state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"deleteFeedbackSession","summary":"Delete a feedback session","description":"Deletes its comments too, and disconnects open widgets. Only your organization can reuse its proxy link's slug for the next 60 days. Requires `feedbackSession:delete`.","tags":["Feedback sessions"],"parameters":[{"schema":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"required":true,"name":"feedbackSessionId","in":"path"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/feedback-sessions/{feedbackSessionId}/sites":{"get":{"operationId":"listFeedbackSessionSites","summary":"List where a feedback session was opened","description":"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`.","tags":["Feedback sessions"],"parameters":[{"schema":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"required":true,"name":"feedbackSessionId","in":"path"}],"responses":{"200":{"description":"The sites","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackSessionSiteList"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/feedback-sessions/{feedbackSessionId}/comments":{"get":{"operationId":"listComments","summary":"List a feedback session's comments","description":"Threads, newest (highest pin number) first, each with its replies. Requires `comment:read`.","tags":["Comments"],"parameters":[{"schema":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"required":true,"name":"feedbackSessionId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Items per page, 1 to 100"},"required":false,"description":"Items per page, 1 to 100","name":"limit","in":"query"},{"schema":{"type":"string","description":"`nextCursor` from the previous page"},"required":false,"description":"`nextCursor` from the previous page","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["open","resolved"]},"required":false,"name":"status","in":"query"},{"schema":{"type":"string","description":"Only comments on this page, e.g. `/pricing`"},"required":false,"description":"Only comments on this page, e.g. `/pricing`","name":"pagePath","in":"query"}],"responses":{"200":{"description":"A page of comments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CommentPage"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/feedback-sessions/{feedbackSessionId}/comments/{commentId}":{"get":{"operationId":"getComment","summary":"Get a comment","description":"With its replies. A reply's id is a 404: replies come inside their comment. Requires `comment:read`.","tags":["Comments"],"parameters":[{"schema":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"required":true,"name":"feedbackSessionId","in":"path"},{"schema":{"type":"string","example":"com_3k9x0c"},"required":true,"name":"commentId","in":"path"}],"responses":{"200":{"description":"The comment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"operationId":"updateComment","summary":"Resolve or reopen a comment","description":"Open widgets update right away. Replies have no status of their own. Requires `comment:resolve`.","tags":["Comments"],"parameters":[{"schema":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"required":true,"name":"feedbackSessionId","in":"path"},{"schema":{"type":"string","example":"com_3k9x0c"},"required":true,"name":"commentId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateComment"}}}},"responses":{"200":{"description":"The updated comment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"deleteComment","summary":"Delete a comment or reply","description":"A comment goes with its replies; a reply's id deletes just that reply. Requires `comment:delete`.","tags":["Comments"],"parameters":[{"schema":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"required":true,"name":"feedbackSessionId","in":"path"},{"schema":{"type":"string","example":"com_3k9x0c"},"required":true,"name":"commentId","in":"path"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/feedback-sessions/{feedbackSessionId}/comments/{commentId}/screenshot":{"get":{"operationId":"getCommentScreenshot","summary":"Get a comment's screenshot","description":"The JPEG in `context.screenshot`: the reviewer's viewport when they pinned the comment, the element outlined. A 404 when the comment has none. Requires `comment:read`.","tags":["Comments"],"parameters":[{"schema":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"required":true,"name":"feedbackSessionId","in":"path"},{"schema":{"type":"string","example":"com_3k9x0c"},"required":true,"name":"commentId","in":"path"}],"responses":{"200":{"description":"The screenshot","content":{"image/jpeg":{"schema":{"type":"string","format":"binary"}}}},"304":{"description":"Not modified: `If-None-Match` has the screenshot's `ETag`, and a screenshot never changes"},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/feedback-sessions/{feedbackSessionId}/comments/{commentId}/replies":{"post":{"operationId":"replyToComment","summary":"Reply to a comment","description":"Shows up in open widgets right away, from the team: under the member's name with a session, under the key's name with an API key. Replies can't have replies, so a reply's id is a 404. Requires `comment:create`.","tags":["Comments"],"parameters":[{"schema":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"required":true,"name":"feedbackSessionId","in":"path"},{"schema":{"type":"string","example":"com_3k9x0c"},"required":true,"name":"commentId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReply"}}}},"responses":{"201":{"description":"The comment, the new reply among its replies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Comment"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/feedback-sessions/{feedbackSessionId}/comments/{commentId}/send-to-agent":{"post":{"operationId":"sendCommentToAgent","summary":"Send a comment to a coding agent","description":"Starts a run of the project's Claude Code scheduled task, or dispatches `annoty-comment` to its GitHub repository, with the comment. Threads only: a reply's id is a 404. Every call starts another run. Requires `comment:sendToAgent` and a plan with `agents`.","tags":["Comments"],"parameters":[{"schema":{"type":"string","example":"fbs_8d2k1m0x7q3c"},"required":true,"name":"feedbackSessionId","in":"path"},{"schema":{"type":"string","example":"com_3k9x0c"},"required":true,"name":"commentId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendToAgent"}}}},"responses":{"200":{"description":"What the first attempt did","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SentToAgent"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with the resource's current state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/projects/{projectId}/notification-destinations":{"get":{"operationId":"listNotificationDestinations","summary":"List a project's notification destinations","description":"Newest first, including those for a single feedback session. Requires `notificationDestination:read`.","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"prj_3k9x0c2m7q1z"},"required":true,"name":"projectId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Items per page, 1 to 100"},"required":false,"description":"Items per page, 1 to 100","name":"limit","in":"query"},{"schema":{"type":"string","description":"`nextCursor` from the previous page"},"required":false,"description":"`nextCursor` from the previous page","name":"cursor","in":"query"}],"responses":{"200":{"description":"A page of notification destinations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDestinationPage"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"operationId":"createNotificationDestination","summary":"Add a notification destination","description":"Up to 10 per project, coding agents included. A webhook's response has its signing secret. Requires `notificationDestination:create` and a plan with the type's feature (Discord: `integrations`, webhook: `webhooks`, coding agents: `agents`). Webhooks are refused (400) while they aren't available to the organization yet.","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"prj_3k9x0c2m7q1z"},"required":true,"name":"projectId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotificationDestination"}}}},"responses":{"201":{"description":"The created notification destination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatedNotificationDestination"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with the resource's current state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/notification-destinations/{destinationId}":{"get":{"operationId":"getNotificationDestination","summary":"Get a notification destination","description":"Requires `notificationDestination:read`.","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"dst_3k9x0c2m7q1z"},"required":true,"name":"destinationId","in":"path"}],"responses":{"200":{"description":"The notification destination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDestination"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"operationId":"updateNotificationDestination","summary":"Update a notification destination","description":"Only the fields you send change. A coding agent takes a new `token`, and no `events`. Requires `notificationDestination:update` and a plan with the type's feature (Discord: `integrations`, webhook: `webhooks`, coding agents: `agents`).","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"dst_3k9x0c2m7q1z"},"required":true,"name":"destinationId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNotificationDestination"}}}},"responses":{"200":{"description":"The updated notification destination","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDestination"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"delete":{"operationId":"deleteNotificationDestination","summary":"Delete a notification destination","description":"Requires `notificationDestination:delete`.","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"dst_3k9x0c2m7q1z"},"required":true,"name":"destinationId","in":"path"}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/notification-destinations/{destinationId}/test":{"post":{"operationId":"testNotificationDestination","summary":"Send a test message","description":"Posts right away, even while the destination is turned off, and logs it as a delivery with `test: true`: Discord gets a short message, a webhook a sample `comment.created` with `test: true`. A Claude Code task gets a `text` that says it's a test, which still starts a run; a GitHub repository gets a dispatch of type `annoty-test`, which starts only workflows that list it. A webhook deleted on Discord's side, one that answers 410, or an agent whose token is refused, turns it off. Requires `notificationDestination:update` and a plan with the type's feature (Discord: `integrations`, webhook: `webhooks`, coding agents: `agents`).","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"dst_3k9x0c2m7q1z"},"required":true,"name":"destinationId","in":"path"}],"responses":{"200":{"description":"What happened","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDestinationTestResult"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/notification-destinations/{destinationId}/secret":{"get":{"operationId":"getNotificationDestinationSecret","summary":"Get a webhook's signing secret","description":"The secret deliveries are signed with now. Webhooks only (400 otherwise). Requires `notificationDestination:update`, like rotating it.","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"dst_3k9x0c2m7q1z"},"required":true,"name":"destinationId","in":"path"}],"responses":{"200":{"description":"The signing secret","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDestinationSecret"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with the resource's current state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/notification-destinations/{destinationId}/rotate-secret":{"post":{"operationId":"rotateNotificationDestinationSecret","summary":"Give a webhook a new signing secret","description":"The old secret stops working at once: deliveries from now on, retries included, are signed with the new one. Webhooks only (400 otherwise). Requires `notificationDestination:update` and a plan with `webhooks`.","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"dst_3k9x0c2m7q1z"},"required":true,"name":"destinationId","in":"path"}],"responses":{"200":{"description":"The new secret","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RotatedNotificationDestinationSecret"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/projects/{projectId}/notification-preferences":{"get":{"operationId":"getNotificationPreferences","summary":"Get your notification preferences for a project","description":"The calling member's own; API keys get 403. Requires `project:read`.","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"prj_3k9x0c2m7q1z"},"required":true,"name":"projectId","in":"path"}],"responses":{"200":{"description":"Your notification preferences","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationPreferences"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"put":{"operationId":"updateNotificationPreferences","summary":"Set your notification preferences for a project","description":"Replaces the calling member's own; API keys get 403. Requires `project:read` and a plan with `notifications`. `email: true` is refused (400) while email notifications aren't available to the organization yet.","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"prj_3k9x0c2m7q1z"},"required":true,"name":"projectId","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNotificationPreferences"}}}},"responses":{"200":{"description":"Your notification preferences","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationPreferences"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/notification-destinations/{destinationId}/deliveries":{"get":{"operationId":"listNotificationDeliveries","summary":"List a destination's deliveries","description":"Newest first, from the last 30 days. Requires `notificationDestination:read`.","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"dst_3k9x0c2m7q1z"},"required":true,"name":"destinationId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Items per page, 1 to 100"},"required":false,"description":"Items per page, 1 to 100","name":"limit","in":"query"},{"schema":{"type":"string","description":"`nextCursor` from the previous page"},"required":false,"description":"`nextCursor` from the previous page","name":"cursor","in":"query"},{"schema":{"type":"string","enum":["pending","delivered","failed"],"description":"Only these"},"required":false,"description":"Only these","name":"status","in":"query"}],"responses":{"200":{"description":"A page of deliveries","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDeliveryPage"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/notification-deliveries/{deliveryId}":{"get":{"operationId":"getNotificationDelivery","summary":"Get a delivery with its body and attempts","description":"The body holds comment text, so this also requires `comment:read`, besides `notificationDestination:read`.","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"dlv_3k9x0c2m7q1zp4a8"},"required":true,"name":"deliveryId","in":"path"}],"responses":{"200":{"description":"The delivery","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDeliveryDetail"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/notification-deliveries/{deliveryId}/redeliver":{"post":{"operationId":"redeliverNotificationDelivery","summary":"Redeliver","description":"Sends the same body again, with the same `webhook-id`, and retries on the usual schedule. Refused (409) while the delivery is still pending or the destination is turned off. Requires `notificationDestination:update` and a plan with the destination type's feature.","tags":["Notifications"],"parameters":[{"schema":{"type":"string","example":"dlv_3k9x0c2m7q1zp4a8"},"required":true,"name":"deliveryId","in":"path"}],"responses":{"202":{"description":"The delivery, pending again","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDelivery"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Conflicts with the resource's current state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/slack/install":{"post":{"operationId":"startSlackInstall","summary":"Start connecting a Slack workspace","description":"The address to send the signed-in member's browser to. Session only. Requires `notificationDestination:create` and a plan with `integrations`.","tags":["Slack"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartSlackInstall"}}}},"responses":{"200":{"description":"Where to go","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackInstallStarted"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/slack/install/complete":{"post":{"operationId":"completeSlackInstall","summary":"Finish connecting a Slack workspace","description":"What Slack sent back to the dashboard. The signed-in member must be the one who started it, so nobody can get a member to connect a workspace to another organization. Session only.","tags":["Slack"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompleteSlackInstall"}}}},"responses":{"200":{"description":"Connected","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackInstallCompleted"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/slack/workspaces":{"get":{"operationId":"listSlackWorkspaces","summary":"List connected Slack workspaces","description":"Requires `notificationDestination:read`.","tags":["Slack"],"responses":{"200":{"description":"The organization's workspaces","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackWorkspaceList"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/slack/workspaces/{teamId}":{"delete":{"operationId":"disconnectSlackWorkspace","summary":"Disconnect a Slack workspace","description":"Its channels stop getting messages and stay listed, turned off, until it's connected again. Requires `notificationDestination:delete`.","tags":["Slack"],"parameters":[{"schema":{"type":"string","minLength":2,"maxLength":32,"example":"T0123ABCD"},"required":true,"name":"teamId","in":"path"}],"responses":{"204":{"description":"Disconnected"},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/slack/workspaces/{teamId}/channels":{"get":{"operationId":"listSlackChannels","summary":"List a workspace's channels","description":"Public channels, and private ones @Annoty was invited to. One page of Slack's list, which can't be searched. Requires `notificationDestination:create`.","tags":["Slack"],"parameters":[{"schema":{"type":"string","minLength":2,"maxLength":32,"example":"T0123ABCD"},"required":true,"name":"teamId","in":"path"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"One page","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackChannelList"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Subscription, plan upgrade or higher limit required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/slack/links/preview":{"get":{"operationId":"previewSlackLink","summary":"See what a Slack link would connect","description":"What the confirm page shows before anything changes, since link previews open links. Session only.","tags":["Slack"],"parameters":[{"schema":{"type":"string","minLength":1},"required":true,"name":"token","in":"query"}],"responses":{"200":{"description":"The Slack account","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackUserLink"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/slack/links":{"post":{"operationId":"linkSlackUser","summary":"Link a Slack account to the signed-in member","description":"Buttons in Slack then act as this member. The workspace must be connected to one of the member's organizations. Session only.","tags":["Slack"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkSlackUser"}}}},"responses":{"201":{"description":"Linked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackUserLink"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"get":{"operationId":"listSlackLinks","summary":"List the signed-in member's linked Slack accounts","description":"Session only.","tags":["Slack"],"responses":{"200":{"description":"Their links","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SlackUserLinkList"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/slack/links/{teamId}/{slackUserId}":{"delete":{"operationId":"unlinkSlackUser","summary":"Unlink a Slack account","description":"Buttons in Slack stop acting as this member. Session only.","tags":["Slack"],"parameters":[{"schema":{"type":"string","minLength":2,"maxLength":32,"example":"T0123ABCD"},"required":true,"name":"teamId","in":"path"},{"schema":{"type":"string","minLength":2,"maxLength":32,"example":"U0123ABCD"},"required":true,"name":"slackUserId","in":"path"}],"responses":{"204":{"description":"Unlinked"},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found, or not visible to the caller's organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/v1/activity":{"get":{"operationId":"listActivity","summary":"List the organization's activity","description":"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`.","tags":["Activity"],"parameters":[{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20,"description":"Items per page, 1 to 100"},"required":false,"description":"Items per page, 1 to 100","name":"limit","in":"query"},{"schema":{"type":"string","description":"`nextCursor` from the previous page"},"required":false,"description":"`nextCursor` from the previous page","name":"cursor","in":"query"},{"schema":{"type":"string","description":"Only this project's activity"},"required":false,"description":"Only this project's activity","name":"projectId","in":"query"},{"schema":{"type":"string","description":"Only this feedback session's activity"},"required":false,"description":"Only this feedback session's activity","name":"feedbackSessionId","in":"query"}],"responses":{"200":{"description":"A page of activity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActivityPage"}}}},"400":{"description":"Invalid request: see `error.details.issues`","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid credentials","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The caller's role or API key scopes don't allow this","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited: retry after `Retry-After` seconds","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"webhooks":{}}