Authentication
Create careCycle API keys and send them with each request.
All API requests require authentication using an API key. Keys start with
cc_. Include your API key in the x-api-key header:
x-api-key: YOUR_API_KEYObtaining API Keys
Production Keys
API keys for production use can be generated from the Developer Dashboard:
- Log in and navigate to the API Keys page
- Click Create API Key
- Give your key a descriptive name and select the exact capabilities it needs
- 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.
Testing in the API Playground
You can generate a temporary API key directly from the API reference pages to quickly test endpoints in the interactive playground.
- Make sure you are logged in.
- Navigate to any API reference page (e.g., List Campaigns)
- Open the Authorization section in the playground
- Click Generate API Key
- If you belong to multiple organizations, select which one to create the key for
Playground keys expire after 14 days, grant only the documented read capabilities, and are intended for testing only. For production integrations, generate a key from the Developer Dashboard.
Failed authentication
Requests with a missing or invalid key return 401 Unauthorized with the
UNAUTHORIZED code. A valid key that lacks the capability an endpoint needs
returns 403 Forbidden with the FORBIDDEN code. See Errors
for the response format and how to recover from each code.
Related
- Rate limits: how many requests each key can make.
- Errors: the error format and every error code.
- Versioning: how API paths are versioned.
- SDKs: generate a typed client from the OpenAPI spec.