Skip to main content

​
Welcome to Userorbit API

The Userorbit API allows you to programmatically interact with your feedback, roadmap, knowledge base, and user onboarding features. Whether you’re building integrations, automating workflows, or embedding Userorbit into your application, our API provides comprehensive access to all platform features.

​
API Architecture

Userorbit provides three tiers of API access:

​
1. Zapier Integration APIs

Built specifically for Zapier workflows, these endpoints enable:
  • Webhook subscriptions for real-time event notifications
  • Polling triggers for periodic data synchronization
  • Sample data for testing and development
  • Dropdown hydration for dynamic form fields

​
2. Public/Widget APIs

Designed for embedded widgets and public portals:
  • Subscriber authentication and tracking
  • Feedback submission from public users
  • Voting and commenting on feedback and topics
  • Knowledge base access for help centers
  • Product tours for user onboarding

​
3. Admin APIs

Full control for team members and administrators:
  • Complete CRUD operations on all resources
  • Advanced filtering and sorting
  • Bulk operations and imports
  • Status management with webhook triggers
  • Team member assignment

​
Key Features

Feedback Management

Collect, organize, and respond to user feedback programmatically

Roadmap & Topics

Publish and manage your product roadmap with public visibility

Knowledge Base

Access and search documentation and help articles

User Onboarding

Create and deliver interactive product tours

​
Base URLs

All API requests should be made to: 
https://api.userorbit.com/v1

​
Authentication

The API uses Bearer token authentication. Include your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
Some endpoints (widget/public APIs) require subscriber authentication via JWT tokens obtained from the subscriber.identify endpoint. Learn more in the Authentication guide.

​
Rate Limits

API requests are rate-limited to ensure fair usage:
  • Standard: 100 requests per minute
  • Burst: 1000 requests per hour
  • Daily: 50,000 requests per day
Rate limit headers are included in all responses: 
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: 1640000000

​
Response Format

All API responses follow a consistent JSON structure: 
{
  "data": { ... },           // Response payload
  "pagination": { ... },      // Pagination info (for list endpoints)
  "error": "...",            // Error message (on errors)
  "success": true            // Success indicator (on mutations)
}

​
Error Handling

The API uses standard HTTP status codes:
Status CodeDescription
200Success
201Created
400Bad Request - Invalid parameters
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
404Not Found - Resource doesn’t exist
429Too Many Requests - Rate limit exceeded
500Internal Server Error
Error responses include details: 
{
  "error": "Invalid API key",
  "message": "The provided API key is not valid or has been revoked",
  "statusCode": 401
}

​
Webhooks

Userorbit supports real-time webhooks for important events. Subscribe via the Zapier API endpoints to receive notifications when:
  • Feedback is created, updated, or status changes
  • Comments are added
  • Votes are cast
  • Topics are published or updated
Learn more in the Zapier Integration section.

​
SDKs & Libraries

Official SDKs coming soon for:
  • JavaScript/TypeScript
  • Python
  • Ruby
  • PHP

​
Support

Need help? We’re here for you:

​
Changelog

Stay updated with API changes:
Ready to get started? Check out the Quickstart Guide or dive into the API Reference.