The Open API Strategy gives developers full access to OnboardFi capabilities. Use REST endpoints to manage customers, portals, tasks, analytics, and AI interactions from your own applications.
Innovation ready
Authentication, rate limits, and monitoring are built in so you can focus on building value--not plumbing.
API Coverage
- Customer & portal management: Create, update, and archive tenants, portals, and stages.
- Task & automation control: Manage tasks, dependencies, and automation rules programmatically.
- Analytics access: Pull health scores, usage metrics, and performance data into your BI stack.
- AI operations: Trigger agent actions, retrieve transcripts, and manage knowledge sources.
Security & Governance
| Feature | Description | Benefit |
|---|---|---|
| OAuth 2.0 auth | Secure client credentials and scoped tokens | Control which apps access what |
| Rate limiting | Protects platform stability | Predictable performance for all tenants |
| Usage dashboards | Monitor calls, errors, and latency | Optimize integrations and troubleshoot quickly |
| Logging & alerts | Detailed request logs with alerting hooks | Maintain auditability and compliance |
Developer Workflow
Register Your Application
Create an API client in the developer console, define scopes, and obtain credentials.
Explore the Reference
Use the interactive API Reference to test endpoints and review schemas.
Prototype in Sandbox
Execute calls against sandbox data to validate logic before impacting production records.
Implement & Secure
Embed API calls in your services, store tokens securely, and respect retry/backoff guidance.
Monitor & Iterate
Review usage dashboards, watch for errors, and optimize performance with pagination or webhooks.
Extension Ideas
Make it your own
Extend OnboardFi into internal systems or customer-facing experiences with minimal friction.
- Build custom executive dashboards inside your BI platform.
- Provision portals directly from your product signup flow.
- Trigger AI agents to gather deployment details via your own interface.
- Sync task data to internal engineering or support tools for end-to-end visibility.
Combine the Open API with Workflow Automation Triggers to blend custom logic with native automation.