Skip to main content

​
Overview

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.ai

​
Authentication

All API requests require authentication using an API key. Include your API key in the x-api-key header: 
x-api-key: YOUR_API_KEY

​
Obtaining API Keys

API keys can be generated from the Developer Dashboard:
  1. Log in and navigate to the API Keys page
  2. Click Create API Key
  3. Give your key a descriptive name and select the appropriate permissions
  4. Copy and securely store your API key - it will only be shown once
Keep your API keys secure. Do not share them in public repositories, client-side code, or expose them in logs. If you believe a key has been compromised, revoke it immediately and generate a new one.

​
Rate Limiting

API requests are rate limited to ensure fair usage and system stability.
API requests are limited to 60 requests per minute.
If you exceed the rate limit, you’ll receive a 429 Too Many Requests response: 
{
  "message": "Rate limit exceeded",
  "code": "RATE_LIMIT_EXCEEDED",
  "retryAfter": 60 // how many seconds to wait before retrying
}

​
Available Resources

Campaigns

Manage outreach campaigns and agent source restrictions

Customers

Access and manage customer records, prescriptions, policies, and more

​
Response Format

All successful responses return JSON with the requested data. Error responses follow a consistent format: 
{
  "message": "<string>",
  "code": "<string>"
}

​
Common Error Codes

CodeDescription
UNAUTHORIZEDInvalid or missing API key
FORBIDDENAPI key lacks required permissions
NOT_FOUNDRequested resource does not exist
VALIDATION_ERRORRequest body failed validation
RATE_LIMIT_EXCEEDEDToo many requests
INTERNAL_ERRORServer error - contact support if persistent

​
OpenAPI Specification

For a complete machine-readable API specification, see the OpenAPI Reference.