Userorbit API#

Manage Userorbit resources programmatically via the REST API.

Setup#

Before the first API call, verify that USERORBIT_API_KEY and USERORBIT_TEAM_ID environment variables are set. If they are missing, ask the user to provide them (available in Settings → API or from the Userorbit onboarding page).

Making API calls#

Use curl directly with the environment variables:

• Base URL: https://api.userorbit.com/api/v1
• All endpoints use POST
• Endpoint format: <resource>.<action> (e.g., announcements.list, feedbacks.create)
• Success response: { "data": ... }
• List response: { "pagination": { "offset", "limit", "total" }, "data": [...] }
• Error response: { "error": "..." }

Usage:

bash

curl -s -X POST "https://api.userorbit.com/api/v1/<endpoint>" \
  -H "Authorization: Bearer ${USERORBIT_API_KEY}" \
  -H "Content-Type: application/json" \
  -H "x-team-id: ${USERORBIT_TEAM_ID}" \
  -d '<json body>'

Example:

bash

curl -s -X POST "https://api.userorbit.com/api/v1/announcements.list" \
  -H "Authorization: Bearer ${USERORBIT_API_KEY}" \
  -H "Content-Type: application/json" \
  -H "x-team-id: ${USERORBIT_TEAM_ID}" \
  -d '{"limit": 5}' | jq '.data'

Resources#

Feedback#

User-submitted feedback with voting, status tracking, and board organization.

OperationEndpointRequired fieldsCreatefeedbacks.create``titleListfeedbacks.list-Getfeedbacks.info``idUpdatefeedbacks.update``idDeletefeedbacks.delete``idArchivefeedbacks.archive``idRestorefeedbacks.restore``idVotefeedbacks.vote``id

Statuses: in_review, planned, in_progress, completed, closed

Sort modes for list: newest, top (by votes), trending (activity)

Feedback Boards#

Organize feedback into boards.

OperationEndpointRequired fieldsCreatefeedback-boards.create``nameListfeedback-boards.list-Getfeedback-boards.info``idUpdatefeedback-boards.update``idDeletefeedback-boards.delete``id

Feedback Comments#

OperationEndpointRequired fieldsCreatefeedback-comments.create``id (feedbackId), textListfeedback-comments.list-Updatefeedback-comments.update``id, textDeletefeedback-comments.delete``id

Comments support type: "public" or "private" (internal notes).

Announcements#

Product updates and changelogs. Require a collectionId (category).

OperationEndpointRequired fieldsCreateannouncements.create``collectionId, title, text, metaListannouncements.list-Getannouncements.info``idUpdateannouncements.update``idDeleteannouncements.delete``idSearchannouncements.search``queryArchiveannouncements.archive``idRestoreannouncements.restore``idPinannouncements.pin``idUnpinannouncements.unpin``id

The meta object supports: ctaTitle, ctaLink, ctaImage, description, feedback.

Set publish: true to publish immediately. Use scheduledAt (ISO date) to schedule.

Announcement Comments#

OperationEndpointRequired fieldsCreateannouncement-comments.create``id (announcementId), textListannouncement-comments.list``id (announcementId)Updateannouncement-comments.update``id, textDeleteannouncement-comments.delete``id

Roadmaps#

OperationEndpointRequired fieldsCreateroadmaps.create``nameListroadmaps.list-Getroadmaps.info``idUpdateroadmaps.update``idDeleteroadmaps.delete``idStagesroadmaps.stages``id

Stages#

Columns within a roadmap (e.g., "Planned", "In Progress", "Done").

OperationEndpointRequired fieldsCreatestages.create``title, roadmapIdListstages.list``roadmapIdGetstages.info``idUpdatestages.update``idDeletestages.delete``id

Topics (Roadmap Items)#

Items that live on a roadmap stage.

OperationEndpointRequired fieldsCreatetopics.create``titleListtopics.list``roadmapId, stageIdGettopics.info``idUpdatetopics.update``idDeletetopics.delete``idCounttopics.count-

Topic Comments#

OperationEndpointRequired fieldsCreatetopic-comments.create``id (topicId), textListtopic-comments.list``id (topicId)Updatetopic-comments.update``id, textDeletetopic-comments.delete``id

Articles (Help Center)#

Knowledge base articles with publishing workflow.

OperationEndpointRequired fieldsCreatearticles.create``title, text, collectionIdsListarticles.list-Getarticles.info``idUpdatearticles.update``idDeletearticles.delete``idSearcharticles.search``queryPublisharticles.publish``idUnpublisharticles.unpublish``idArchivearticles.archive``idRevisionsarticles.revisions``idRestorearticles.restore``id, revisionId

Article statuses: draft, published, archived

Article Collections (Help Center Categories)#

OperationEndpointRequired fieldsCreatearticle-collections.create``nameListarticle-collections.list-Getarticle-collections.info``idUpdatearticle-collections.update``idDeletearticle-collections.delete``id

Article Votes#

OperationEndpointRequired fieldsGetarticle-votes.info``id (articleId)Votearticle-votes.create``id (articleId), value ( helpful or not_helpful)Removearticle-votes.delete``id (articleId)

Collections (Announcement Categories)#

OperationEndpointRequired fieldsCreatecollections.create``nameListcollections.list-Getcollections.info``idUpdatecollections.update``idDeletecollections.delete``id

Tags#

Labels for organizing feedback.

OperationEndpointRequired fieldsCreatetags.create``nameListtags.list-Gettags.info``idUpdatetags.update``id, nameDeletetags.delete``id

Subscribers#

Public users who interact with your product.

OperationEndpointRequired fieldsCreatesubscribers.create``email, name, passwordListsubscribers.list-Updatesubscribers.update``idDeletesubscribers.delete``idCountsubscribers.count-Searchsubscribers.search-

Projects#

OperationEndpointRequired fieldsCreateprojects.create``nameListprojects.list-Getprojects.info``idUpdateprojects.update``idDeleteprojects.delete``id

Feedback Board Tags#

Associate tags with feedback boards.

OperationEndpointRequired fieldsCreatefeedback-board-tags.create``boardId, tagIdListfeedback-board-tags.list``boardIdUpdatefeedback-board-tags.update``boardId, oldTagId, newTagIdDeletefeedback-board-tags.delete``boardId, tagId

Common Workflows#

Create and publish an announcement#

1. Call collections.list to find the right collectionId
2. Call announcements.create with collectionId, title, text, meta, and publish: true

Add a topic to a roadmap#

1. Call roadmaps.list to find the roadmapId
2. Call roadmaps.stages with the id to find the stageId
3. Call topics.create with title, roadmapId, stageId, and publish: true

Publish a help center article#

1. Call article-collections.list to find collection IDs
2. Call articles.create with title, text, and collectionIds
3. Call articles.publish with the article id

Detailed API Reference#

For full request/response schemas with all optional fields, see references/api.md.