API Overview
This section groups the AidOrbit REST API by top-level resources and provides curated, example-led documentation for each resource. Use the links below to jump to the resource you need.
Resource groups
- Authentication — signup, login, refresh, logout
- Programs — create and manage programs, schedules, and volunteers
- Shifts — shift scheduling, signups, check-in/check-out
- Volunteers — volunteer profiles and management
- Organizations — organizations, roles, and permissions
- Documents & Envelopes — upload, envelopes, e-sign workflows
- Forms — form definitions and submissions
- Webhooks — registering and processing webhooks
- Jobs — background jobs and cron endpoints
- Integrations — social and external integrations
- Analytics & Events — event ingestion and analytics
- Locations & Missions — geodata and Mission records
- Journeys — multi-step journeys and enrollments
- Badges — badges and awards
- SCIM — SCIM user provisioning
- Compliance — compliance reviews and approvals
Reference
- Sandbox and API Explorer — synthetic test data, safe first requests, and explorer guidance
- Full machine-readable API: OpenAPI spec
Resource pages use Mission terminology for user-facing concepts. API paths may still expose legacy opportunities names where the backend contract requires them.