CSRF token, also set as the (non-HttpOnly) clypp_csrf cookie. Returned in the body too because cross-site deployments (frontend and API on different domains) cannot read the cookie back via document.cookie.

Acme Corporation

Number of (non-deleted) posts on this board

Period to write (YYYY-MM-DD). Defaults to today. Re-running a period corrects that row rather than adding a duplicate.

How this capture was triggered. Scheduled captures are written by the cron.

Account (umbrella) the billing applies to

Plan to switch the account's existing subscription to — never "free" (that's a cancellation, not a plan change).

Number of linked posts (when posts not included)

Add dark mode support

Whether the requesting user has liked this comment (false if unauthenticated)

replyCount > 0 — lets the client show a "view replies" affordance without a separate check

True if this comment was deleted — content/author are masked (null) rather than the row being omitted, so replies stay attached to the thread

estimated_effort

IDs of completed posts to link to this changelog

URL slug (auto-generated from the title when omitted)

Pipeline value blocked by this post, in dollars

Where Dodo Payments sends the customer back after checkout — varies per call site (onboarding, billing page, marketing page), so the frontend supplies it, same as Paddle's successUrl.

Formula expression (e.g., "votes*1 + mrr*0.01 - effort*5")

Post status this column maps to (keeps the board synced)

Internal columns are dropped from the customer-facing public roadmap

Prioritization framework used to score items

Opaque cursor for the next page, or null if there is no more data

Board the post will be created on (used to scope by organization)

Override the default similarity threshold (0-1)

Email address to send password reset link

Invite to the account (root) or to one of its organizations

Replace existing linked posts (default: false - adds to existing)

Refresh token to revoke (optional; cookie is used if present)

Array of post IDs to merge (will be marked as duplicates)

Target post ID to merge into (will receive all votes and comments)

Parent account (umbrella) this org belongs to

Inherited from the parent account (umbrella)

Feature Requests

Original filename (informational only, not used for the storage key)

Sub-folder to store the file under (e.g. avatars)

Deal value at the moment of the outcome. Defaults to the blocker’s current value, which is mutable and may since have drifted.

Why the deal was lost. Only meaningful when outcome is "lost".

When the outcome happened, if backdating. Defaults to now.

What actually happened to the deal. "lost" is the highest-value record in the system — a labelled example of an unbuilt feature costing revenue.

CSRF token — see AuthResponseDto.csrfToken.

Refresh token. Optional — normally read from the HttpOnly `clypp_refresh` cookie; only used as a fallback for non-browser clients.

Amount in cents. Omit to pay out the full available balance.

Email address to resend the verification link to

The comment content to generate replies for

Cap how many not-yet-synced posts this run pushes to the provider (1-50). Omit to use the default cap.

Updated comment content (supports Markdown)

Updated pipeline value blocked, in dollars

When true, integration connections requiring a manually-pasted token are blocked for providers that have a working OAuth (or GitHub App install) alternative — enterprise customers use this to keep credentials revocable via their own IdP/admin console instead of a personal token pasted into a shared org.

User preferences including language, theme, and notification settings

Base64-encoded data URL, e.g. data:image/png;base64,iVBORw0K...

Email verification token from the verification link

clypp_access

Clypp API

Create a new account (enterprise umbrella)

token

Get the caller's primary account with their root role

invitationId

Resend a pending account invitation email

page

limit

List root members + pending account invitations

Invite a user to the account (root) or one of its organizations

userId

List non-root members (organization members under this account) + pending org invitations

Record that the account owner chose to stay on the free plan from the registration onboarding step

Aggregate usage across the account vs. plan limits

boardId

Time period for analytics (default: month)

period

startDate

endDate

Restrict results to a single board (product) instead of the whole organization

organizationId

Per-segment member count, votes cast, and average MRR/ARR

Get analytics broken down by user segment

Dashboard chart data (status breakdown, top posts, feedback volume)

Get lightweight chart data for the dashboard home page

Get dashboard summary stats (totals + changes)

Get deal blockers aggregated by post, ranked by open pipeline value blocked

format

Get product area heatmap (votes + post count per board)

Restrict trends to a single board (product)

Invalid current password or other validation error

Password reset email sent if account exists

provider

redirectUri

Optional state parameter for CSRF protection

state

Register a new user with email and password

Verification email sent if the account exists and is unverified

Verify email address with a token from the verification email

Get execution history for an automation rule

Permanently delete a saved payment method — 400s if the active provider has no concept of one independent of a subscription

Switch the account's existing subscription to a different plan tier (never creates a second subscription)

Create a Stripe Checkout session to upgrade the plan

Create a Dodo Payments hosted checkout session for a new subscription

accountId

Start PayPal onboarding; returns a redirect URL

Refresh and return PayPal merchant status

Create a self-service billing portal session; returns a redirect URL

Start Stripe Connect onboarding; returns a redirect URL

Refresh and return Stripe Connect status + balance

List the account's subscriptions on the active billing provider

Cancel one of the account's subscriptions immediately

How to update the payment method for one subscription — either an inline-checkout transaction id or a redirect url, depending on the provider

webhook-id

webhook-signature

webhook-timestamp

x-signature

paddle-signature

stripe-signature

search

visibility

Get current user boards, optionally filtered by organization

slug

categoryId

type

published

Generate an AI changelog draft from linked posts

Get recent changelog entries for an organization

Announce changelog to voters of linked posts

postId

Never returns nested replies — use GET /comments/:id/replies to lazily load a comment's replies once expanded. Each item carries replyCount/hasReplies so the client knows whether that affordance applies.

"new" = most recent first, "top" = most liked first, "best" = hot ranking

sort

Opaque cursor from a previous page's nextCursor

cursor

"internal" is team-only comments; "all" mixes public and internal together. Either requires the caller be an owner/admin/member of the post's organization or this 403s, regardless of what this param says.

scope

Get root (top-level) comments for a post, cursor-paginated

Toggle the current user's like on a comment

Get a comment's replies, cursor-paginated (lazy-loaded)

Summarize a single comment (returns the original if already short)

Toggle comment internal/external visibility

The service is healthy

The Health Check is successful

The service is unhealthy

The Health Check is not successful

Sync a HubSpot/Salesforce connection’s accounts and contacts into user attributes

itemId

Manually push (or refresh) a single standalone roadmap item to a single connection

Manually push (or refresh) a single post to a single connection

Recent delivery attempts (real and test) for a webhook connection

Send a synthetic test event to a webhook endpoint (the simulator)

Sync status for a post across every eligible connection in its org

Sync status for a roadmap item across every eligible connection in its org

List an organization's webhook connections (with decrypted URL, never the secret)

Canonical list of outbound webhook events a connection can subscribe to

unreadOnly

All notifications marked as read successfully

Notification preferences retrieved successfully

Notification preferences updated successfully

Get all organizations (admin only — cross-tenant directory)

Get current user organization (first/default)

subdomain

Get organization-wide integration policy (e.g. OAuth-only enforcement)

Update organization-wide integration policy (owner/admin only)

Get fine-grained permission overrides for an organization

Update fine-grained permission overrides for an organization

Get organization resource usage against plan limits

orgId

keyId

Splits resolved from lost with its own timestamp and reason. Whether the blocking feature had shipped before the deal closed is derived from the ship event, not supplied.

dealBlockerId

A semantic index for agent consumers: what each query answers, what it does not, and how far the data can be trusted. Static — safe to cache.

Machine-readable description of the outcome corpus

How much revenue history exists, and whether outcomes can be measured yet

Returns the ranking plus the divergence — the items the vote count has been ranking wrongly, which is usually the more useful half.

Rank by expected value per unit of effort instead of raw value.

byValuePerEffort

Share of open pipeline attributed to the blocking feature. Shipping alone does not win a blocked deal, so full attribution overstates the case.

openDealWinUplift

Rank open requests by expected revenue rather than vote count

Writes one row per account for the period. Re-running the same period corrects that row rather than duplicating it. Normally handled by the weekly scheduler.

The corpus query most companies cannot answer about their own backlog. Ranked by deals recorded lost against each request, then by revenue behind its voters.

months

What was asked for and never built, ranked by what it cost

Compares accounts that requested the feature against those that did not, either side of the recorded ship date. Descriptive, not causal — the response carries its own caveat.

Days either side of the ship date to compare. Longer windows capture slower effects but admit more unrelated movement.

windowDays

Post not found, or never recorded as shipped

What happened to revenue after this shipped

Append-only lifecycle timeline for a post

Restrict results to boards owned by this organization

status

priority

authorId

assignedToMe

minVotes

maxVotes

includeInternal

sortBy

sortOrder

Find existing posts similar to a draft ("similar posts")

Get posts ranked by revenue-aware prioritization score

Backfill: (re)embed all posts on a board into the AI service

A board in the organization to search within

Semantic (AI) search across an organization’s posts

dealId

Update a deal blocker (status, value, notes)

x-api-key

List an organization's approval requests, optionally filtered by status

API reference

Auth