The Spruce API connects Spruce to internal tools, electronic health records (EHRs), and external systems so practices can automate workflows, sync data, and extend platform functionality. The API includes standard RESTful endpoints plus webhooks for real-time event notifications. Common use cases include syncing contacts and chat data, triggering automated messages (e.g., appointment reminders), pushing conversation data into patient charts, deep linking, and inviting patients to Spruce. Practices without internal developers can work with integration partners like Keragon or Morf Health. Implementation details are covered in the Spruce Integration Guide.
⚠️ To use the Spruce API, you must be on the Communicator plan, and you’ll need support from Engineering or Development resources on your team.
IN THIS ARTICLE
Common Use Cases
With the Spruce API and webhooks, you can:
Sync Contacts & Charts: Automatically create and update contacts in Spruce based on external systems (e.g., syncing with your EHR or CRM).
Maintain Accurate Records: Ensure patient contact info and key demographics stay updated across systems.
Trigger Messages Automatically: Send secure messages, SMS or faxes from Spruce when specific events occur in your systems—like appointment reminders, follow-ups, or onboarding sequences.
Streamline Documentation: Push Spruce conversation data into other systems (e.g., update a patient’s chart in your EHR with relevant messages or notes).
Enable Deep Linking: Launch Spruce from within another system, or vice versa, for seamless navigation and workflow integration.
- Invite Patients to Spruce: Programmatically send invitations to patients to join your organization on Spruce.
You can read all about the API and its functionality on the developer documentation page here.
How to get access to the API
If you are interested in using the Spruce API, here are the steps to get started:
- Create a separate Spruce organization for testing purposes. To do this, click here or log out of your current Spruce account, and create a new organization.
- Send us a message in the "Team Spruce" conversation in the new organization you've just created letting us know this is a test organization for use with the Spruce API.
- We will mark that organization as a test org and enable the API so you can start building and testing anything you want.
- Once you've completed your testing, have an admin from your main Spruce organization message us in the "Team Spruce" conversation requesting that we enable the API for your organization.
- Once the API is enabled, you can generate tokens from your Spruce settings, under "Integrations & API."
**Please Note: If you're working with one of our integration partners—such as Keragon, Athena, Akute Health, or others that already have an established integration with us—you can skip the "Create Test Organization" step. If that applies to you, just let us know!
Testing SMS Messaging
Please note that if you are testing SMS messaging via the API, outgoing SMS messages will not be delivered because the account is unregistered. However, registration is not needed for API test accounts. If you attempt to send an SMS, you will receive an error indicating the account is unregistered, but the error will only appear if the message attempt is made, allowing you to still test outgoing SMS functionality.
If you need any help with this process, just message Team Spruce in your app and we'll be happy to help! You can also email our sales team at sales@sprucehealth.com if you have questions about how Spruce works with different healthcare practices.
**If you are interested in connecting Spruce to one of your tools but don't have the Engineering or Development resources to leverage the API yourself, we recommend you try out Keragon (more about Spruce <> Keragon here) or Morf Health (more about Spruce <> Morf Health here).
Frequently Asked Questions
Which Spruce plan includes API access?
API access requires the Communicator plan.
What can be built with the Spruce API?
Use cases include syncing contacts and chat data, integrating with an EHR, triggering automated messages such as appointment reminders, pushing conversation data into patient charts, deep linking, inviting patients to Spruce, and triggering actions in Spruce or external systems through webhooks. Practices without engineering resources can use integration partners such as Keragon or Morf Health.
Does the Spruce API support real-time events?
Yes, webhooks deliver real-time event notifications so external systems can react to events happening inside Spruce.