userorbit（userorbit 搜索）

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:

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:

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.

Statuses: in_review, planned, in_progress, completed, closed

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

Feedback Boards

Organize feedback into boards.

Feedback Comments

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

Announcements

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

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

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

Announcement Comments

Roadmaps

Stages

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

Topics (Roadmap Items)

Items that live on a roadmap stage.

Topic Comments

Articles (Help Center)

Knowledge base articles with publishing workflow.

Article statuses: draft, published, archived

Article Collections (Help Center Categories)

Article Votes

Collections (Announcement Categories)

Tags

Labels for organizing feedback.

Subscribers

Public users who interact with your product.

Projects

Feedback Board Tags

Associate tags with feedback boards.

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.