Developer Documentation — For full API reference including endpoints, request/response formats, and usage examples, see the interactive API documentation.
Organizations on advanced tier plans have access to the Orbit API, providing programmatic access to your portal's data for custom integrations and automation.
Authentication
When the API is enabled, you can generate an API token from Settings > API in the admin portal. This token is used to authenticate requests via the Authorization header:
Authorization: Bearer your-api-token
Tokens can be regenerated at any time if needed. Keep your token secure — it provides full API access to your portal data.
Available Endpoints
The API provides access to the following resources:
- Users — manage user accounts and profiles
- Emails — access email data
- Announcements — create and manage announcements
- Member Directory — access and manage directory entries
- Events — manage events and registrations
- Courses — manage courses and enrollments
API Documentation
For full details on available endpoints, request/response formats, and usage examples, see the interactive API documentation.
Coming Soon
The following API features are planned:
- Webhooks — receive real-time notifications when events occur on your portal (registrations, enrollments, membership changes, and more), enabling event-driven integrations with third-party systems