The WellPlan REST API exposes contacts, conversations, opportunities, calendars, workflows, custom fields, and more as standard HTTP endpoints, secured with API keys or OAuth depending on the integration model. Developers can read and write data programmatically to power internal tools, mobile apps, headless storefronts, or custom integrations that go beyond the visual workflow builder. Combined with webhooks for event delivery, the REST API turns WellPlan into a platform — anything that runs on the CRM through the UI can also be triggered from code, version-controlled, and deployed alongside the rest of your stack.
Features
Common use cases
Build a custom client portal
A SaaS company exposes a branded client portal that reads deals, invoices, and conversations from WellPlan via the REST API. Clients see real-time pipeline status without logging into the CRM, and updates from the portal write back through API actions.
Migrate data into WellPlan at scale
A migrating business uses the REST API to import historical contacts, deal history, and notes from a legacy CRM. Scripted batches handle hundreds of thousands of records with proper rate-limit handling, far faster than a manual CSV import.
Power a headless integration
An e-commerce platform sends order events from a custom Node service to WellPlan via the API rather than relying on a pre-built connector. The team gets exactly the fields and flows they want, and treats the integration as code under version control.
How setup works
- 1Generate an API key from WellPlan's API settings, or set up an OAuth app for multi-tenant access.
- 2Review the API documentation for the endpoints you need and the rate-limit guidelines.
- 3Make a test request from a tool like curl or Postman to confirm authentication and a successful response.
- 4Implement the calls in your application, handle errors and pagination, and monitor rate-limit headers.
Frequently asked questions
How is the API authenticated?+
The API supports API keys for server-to-server access and OAuth 2.0 for integrations that act on behalf of other accounts. API keys are scoped to your account, and OAuth tokens are scoped to whichever permissions the authorizing user grants the app at install time.
What are the rate limits?+
Rate limits are applied per account and per endpoint to protect platform stability. The exact limits are published in the API documentation, and each response includes headers showing remaining quota. Well-behaved clients back off when limits are approached.
Is there a sandbox environment?+
Many development workflows use a separate WellPlan account as a sandbox for safe testing of API integrations before going to production. This keeps test contacts and synthetic deals out of the production environment and avoids triggering real customer communications.
What about pagination?+
List endpoints return pages of results with cursor or offset-based pagination depending on the endpoint. Clients should follow the pagination metadata in each response rather than hard-coding page sizes, since limits can change as the platform evolves.