UpVoiced docs

Build on UpVoiced

Read and write your feedback, roadmap and changelog from your own code, an AI assistant or your product. Every endpoint, parameter and example on this site is generated from the API's own OpenAPI document.

• API reference

  205 operations in 27 groups, each with curl, SDK and MCP examples side by side.

• TypeScript SDK

  @upvoiced/sdk: typed paths, bodies and responses, retries and pagination.

• MCP server

  18 tools for Claude, Cursor and other MCP clients, with the same API keys.

• Feedback widget

  Install the widget with one script tag, then identify your signed-in users.

• Single sign-on

  Sign your users in to the widget and portal with a short-lived token from your server.

• Webhooks

  Signed event deliveries for posts, comments, votes, the changelog and end users.

Quick start

1. In the dashboard, open Settings → API keys, create a key with the scope you need and copy it. Keys start with uv_live_.
2. Every workspace call names its workspace in X-Workspace: your workspace id is the Audience shown under Settings → Single sign-on.
3. Call the API:

curl https://api.upvoiced.com/v1/boards \
  -H "Authorization: Bearer $UPVOICED_API_KEY" \
  -H "X-Workspace: $UPVOICED_WORKSPACE_ID"

Guides

• Authentication
• Pagination
• Errors
• Idempotency
• Rate limits
• Webhooks
• Versioning

Operator API

The resources an API key can work with:

• Workspace: The workspace itself: settings, single sign-on, widget settings, deletion and restore.
• Members and invitations: The team: members, their roles, and pending invitations.
• Boards: Feedback boards, their visibility and order.
• Posts: Feedback posts: list, search, create, update, approve, merge and bulk changes.
• Comments: Public replies on posts, including official team answers and pinned comments.
• Internal notes: Team-only notes on posts, with mentions and reactions.
• Votes and followers: Votes and followers of a post, including votes on behalf of your customers.
• Statuses: The workflow statuses posts move through, and their categories.
• Tags: Tags for organising posts.
• Roadmap: The roadmap view of posts by status category, and its visibility.
• Changelog: Changelog entries: drafts, scheduling, publishing and preview links.
• Webhooks: Webhook endpoints, signing secrets, the delivery log, test sends and redelivery.
• Slack and Discord integrations: Slack and Discord connections from an incoming-webhook URL: per-event templates, board filters, test messages and the delivery log.
• Moderation: Reports, held comments and blocked end users.
• Imports: Imports of posts, comments and votes from other tools.
• Exports: Exports of the workspace data.
• Media uploads: Pre-signed uploads for post images and changelog media.
• Branding: Portal and widget branding, custom CSS and import from your site.
• Custom domains: Custom portal hostnames and their verification.
• Billing and credits: The plan, checkout and billing portal sessions, plan changes and AI credits.
• AI settings: AI features, their provider credentials and a connection test.
• API keys: API key management. Dashboard session only: an API key cannot create or revoke keys.
• Notification preferences: Your own notification preferences and the workspace notification settings.
• End users: Personal-data deletion requests for one of your end users.