We have rolled out phase one of the Carepatron Public API. This first release covers contact export, giving developers the ability to pull contact data out of Carepatron and into their own systems.
The interactive reference covering every endpoint, parameter, and schema is at developer.carepatron.com/openapi. The raw OpenAPI spec is available as YAML or JSON for tooling and code generation.
Who this is for: Developers and technical teams building integrations with Carepatron. You will need an API key from developer.carepatron.com to get started.
What is available in phase one
Contacts export
Phase one exposes contacts export. Submit an export request, and the API returns a job you poll until it completes, then retrieve your contacts data. This async pattern (202 Accepted) is used for operations that take time to process.
More endpoints are coming. Phase one is the start. Additional functionality covering more of the Carepatron platform will be released in subsequent phases.
Base URL: https://api.carepatron.com
Authentication
Every request requires an API key sent in a request header. Create your key at developer.carepatron.com.
Treat API keys as secrets. Never embed them in client-side code or commit them to source control. Anyone with the key can use it for everything the key's scopes allow.
Conventions
Errors follow RFC 7807: Responses use application/problem+json with a machine-readable code, a human-readable message, and optional field-level details.
Rate limits on every response: RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset headers are returned with every call. A 429 means slow down and retry after the window resets.
Idempotency keys for write operations: Pass an Idempotency-Key header on write requests to ensure a retried request is applied at most once.
Long-running operations return 202: Operations like contacts export return 202 Accepted with a job ID. Poll the job until it succeeds or fails.
Versioning
The API is versioned by date. Pass the version in a request header so your integration keeps working as the API evolves. The current version value is listed in the API reference.
Check out Carepatron's API documentation here.
Our team is here to help with any questions or concerns. Just open a conversation through the Help channel in your workspace.