Skip to content
UpVoiced Docs

API reference

UpVoiced API reference

Base URL https://api.upvoiced.com. JSON in, JSON out. Every operation below is generated from the OpenAPI 3.1.0 document (version 0.1.0) at build time, so this page lists exactly what the API serves.

Who can call what
Label in the referenceCredentials
API key or Dashboard sessionAuthorization: Bearer uv_live_… and X-Workspace: <workspace id>
Dashboard session only (API keys get 403 session_required)A signed-in operator in the Dashboard; keys cannot manage keys, delete a workspace or rotate the SSO secret.
End-user session (widget)The widget’s end-user session token and X-Workspace: <slug>
None (public)Nothing; X-Workspace: <slug> picks the workspace

Operator API

Called with an API key (or a Dashboard session) and X-Workspace.

  • Workspace

    The workspace itself: settings, single sign-on, widget settings, deletion and restore. 13 operations.

  • Members and invitations

    The team: members, their roles, and pending invitations. 7 operations.

  • Boards

    Feedback boards, their visibility and order. 8 operations.

  • Posts

    Feedback posts: list, search, create, update, approve, merge and bulk changes. 13 operations.

  • Comments

    Public replies on posts, including official team answers and pinned comments. 5 operations.

  • Internal notes

    Team-only notes on posts, with mentions and reactions. 5 operations.

  • Votes and followers

    Votes and followers of a post, including votes on behalf of your customers. 5 operations.

  • Statuses

    The workflow statuses posts move through, and their categories. 5 operations.

  • Tags

    Tags for organising posts. 4 operations.

  • Roadmap

    The roadmap view of posts by status category, and its visibility. 2 operations.

  • Changelog

    Changelog entries: drafts, scheduling, publishing and preview links. 11 operations.

  • Webhooks

    Webhook endpoints, signing secrets, the delivery log, test sends and redelivery. 9 operations.

  • Slack and Discord integrations

    Slack and Discord connections from an incoming-webhook URL: per-event templates, board filters, test messages and the delivery log. 7 operations.

  • Moderation

    Reports, held comments and blocked end users. 8 operations.

  • Imports

    Imports of posts, comments and votes from other tools. 5 operations.

  • Exports

    Exports of the workspace data. 3 operations.

  • Media uploads

    Pre-signed uploads for post images and changelog media. 2 operations.

  • Branding

    Portal and widget branding, custom CSS and import from your site. 7 operations.

  • Custom domains

    Custom portal hostnames and their verification. 3 operations.

  • Billing and credits

    The plan, checkout and billing portal sessions, plan changes and AI credits. 8 operations.

  • AI settings

    AI features, their provider credentials and a connection test. 13 operations.

  • API keys

    API key management. Dashboard session only: an API key cannot create or revoke keys. 3 operations.

  • Notification preferences

    Your own notification preferences and the workspace notification settings. 3 operations.

  • End users

    Personal-data deletion requests for one of your end users. 2 operations.

Public portal API

No credentials: what your public portal shows.

  • Public portal API

    Unauthenticated reads of public boards, posts, the roadmap and the changelog, plus end-user sign-in and changelog subscriptions. What your portal uses. 22 operations.

Widget API

Called by the widget with a signed-in end user’s session.

  • Widget API

    What the feedback widget calls with a signed-in end user’s session: posting, voting, following, comments and the user’s own data. 27 operations.

Platform

Health checks and provider callbacks.

  • Platform endpoints

    Health checks and the endpoints UpVoiced’s own infrastructure and providers call (billing and email events, inbound email). Integrations never call these. 5 operations.