.png?fit=max&auto=format&n=EQK5eX9kTD8NzWwA&q=85&s=878008bf159fcc4964d0c0d508b6e400)
Looking to use HoopAI as a business user? Start with the Getting Started guide instead.
Who is this for?
These developer docs are designed for:- Integration developers building apps that connect HoopAI with external systems
- Marketplace developers creating apps for the HoopAI App Marketplace
- Agency developers building custom solutions for clients on HoopAI
- Internal teams automating business processes through the API
What you can build
Marketplace apps
Build apps that any HoopAI user can install from the marketplace. Monetize your integration with subscription billing.
Custom integrations
Connect HoopAI with your existing tools — sync contacts with your ERP, push leads to your data warehouse, or trigger external workflows.
Workflow automation
Use webhooks and the API to create advanced automations that go beyond the built-in workflow builder.
White-label solutions
Agencies can build custom portals, dashboards, and experiences on top of HoopAI using the SaaS API.
Platform architecture
HoopAI uses a multi-tenant architecture with two levels:| Level | Description | API scope |
|---|---|---|
| Company | The top-level account that manages accounts, billing, and platform settings | Company-level API tokens |
| Account (Location) | Individual business accounts with their own contacts, calendars, pipelines, and settings | Location-level API tokens |
Core platform modules
| Module | What it does | Key APIs |
|---|---|---|
| CRM | Contacts, companies, custom fields, tags, notes, tasks | Contacts API |
| Conversations | Omnichannel messaging — SMS, email, chat, WhatsApp, social | Conversations API |
| Calendars | Appointment booking, availability, scheduling links | Calendars API |
| Pipelines | Sales opportunities, deal stages, pipeline management | Opportunities API |
| Payments | Invoices, orders, subscriptions, payment processing | Payments API |
| Marketing | Email campaigns, social posting, funnels | Emails, Social |
| Automation | Workflow triggers, webhook events, drip campaigns | Workflows API |
Next steps
Quick start
Make your first API call in under 5 minutes.Go to the quick start
Set up authentication
Learn how OAuth 2.0 works with HoopAI and get your access token.Read the authentication guide
Explore the API
Browse the full API reference with interactive examples.View the API reference