Overview
Complete reference for the careCycle Public API
The careCycle API provides programmatic access to manage campaigns, customers, calls, and more. All endpoints use JSON for request and response bodies.
Base URL
https://api.carecycle.aiAuthentication
All API requests require an API key passed via the x-api-key header. See Authentication for details on obtaining and using API keys.
Available Resources
Authentication
Create API keys and send them with each request.
Rate Limits
Per-key request limits and how to back off.
Errors
The error format, every error code, and how to recover.
Versioning
How the API is versioned.
SDKs
Generate a client library from the OpenAPI spec.
Campaigns
Manage outreach campaigns and agent source restrictions.
Customers
Access and manage customer records, prescriptions, policies, and more.
Inquiries
View and manage customer inquiries.
Custom Fields
Define and manage custom field definitions.
Leads
Upload lead records for campaigns.
Sources
Create and manage source tracking assignments for campaign attribution.
Sync
Sync Medicare and ACA customer and policy data.
OpenAPI Specification
The careCycle API is documented using the OpenAPI 3.1 specification. Use it to generate client libraries, import into API tools like Postman, or validate requests.
The same spec is served at stable URLs for tools and agents:
Every page in these docs is also available as Markdown: add .md to its URL
(for example, /docs/api-reference/errors.md).
An index of all pages is at /llms.txt.