Explore the interactive API documentation — browse all endpoints, see request/response schemas, and test API calls directly from your browser.
Orbit provides a RESTful API for programmatic access to your portal's data — managing users, events, courses, resources, announcements, and more. Available on advanced tier plans.
The API reference and playground is powered by OpenAPI and lets you:
- Browse all endpoints with detailed descriptions and parameter schemas
- See request/response examples for every operation
- Test API calls directly from your browser with your API token
- Download the OpenAPI schema for code generation or import into tools like Postman
Authentication
The API supports two authentication methods:
Bearer Token (External Integrations)
Generate an API token from Settings > API in the admin portal. Include it in the Authorization header:
Tokens can be regenerated at any time. Keep your token secure — it provides full API access to your portal data.
Session (Browser / Staff)
Staff members who are logged into the portal can call the API directly from the browser or via JavaScript — no token required. This uses the existing session cookie.
Available Endpoints
The API provides access to the following resources:
| Resource | Operations |
|---|---|
| Users | List, create, update, and manage user accounts and profiles |
| Emails | Access email records and history |
| Announcements | Create and manage announcements |
| Member Directory | Access and manage directory entries |
| Events | Manage events and registrations |
| Courses | Manage courses and enrollments |
For complete endpoint documentation with request/response schemas, see the interactive API docs.
Quick Start
1. Enable the API
Go to Settings > API in the admin portal and enable API access.
2. Generate a Token
Click Generate Token on the API settings page. Copy the token — it's only shown once.
3. Make a Request
4. Explore the Docs
Visit the API reference and playground to see all available endpoints and test them interactively.
App Connector API
In addition to the main portal API, Orbit provides a separate App Connector API for embedded applications. This API uses short-lived signed tokens (not the portal API token) and provides:
- User context and membership status
- Per-user, per-app state storage
See Applications for full details on the App Connector API.
Coming Soon
- Webhooks — receive real-time notifications when events occur on your portal (registrations, enrollments, membership changes), enabling event-driven integrations with third-party systems