# Overview (/docs/api-reference)



The careCycle API provides programmatic access to manage campaigns, customers, calls, and more. All endpoints use JSON for request and response bodies.

Base URL [#base-url]

```
https://api.carecycle.ai
```

Authentication [#authentication]

All API requests require an API key passed via the `x-api-key` header. See [Authentication](/docs/api-reference/authentication) for details on obtaining and using API keys.

Available Resources [#available-resources]

<Cards>
  <Card title="Authentication" description="Create API keys and send them with each request." href="/docs/api-reference/authentication" />

  <Card title="Rate Limits" description="Per-key request limits and how to back off." href="/docs/api-reference/rate-limits" />

  <Card title="Errors" description="The error format, every error code, and how to recover." href="/docs/api-reference/errors" />

  <Card title="Versioning" description="How the API is versioned." href="/docs/api-reference/versioning" />

  <Card title="SDKs" description="Generate a client library from the OpenAPI spec." href="/docs/api-reference/sdks" />

  <Card title="Campaigns" description="Manage outreach campaigns and agent source restrictions." href="/docs/api-reference/campaigns/list-campaigns" />

  <Card title="Customers" description="Access and manage customer records, prescriptions, policies, and more." href="/docs/api-reference/customers/get-paginated-list-of-customers" />

  <Card title="Inquiries" description="View and manage customer inquiries." href="/docs/api-reference/inquiries/list-inquiries" />

  <Card title="Custom Fields" description="Define and manage custom field definitions." href="/docs/api-reference/custom-fields/list-custom-fields" />

  <Card title="Leads" description="Upload lead records for campaigns." href="/docs/api-reference/leads/upload-lead-records" />

  <Card title="Sources" description="Create and manage source tracking assignments for campaign attribution." href="/docs/api-reference/sources/list-all-sources" />

  <Card title="Sync" description="Sync Medicare and ACA customer and policy data." href="/docs/api-reference/sync/sync-medicare-customers-and-policies" />
</Cards>

OpenAPI Specification [#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.

<Cards>
  <Card title="Download OpenAPI Spec (YAML)" href="/api-reference/openapi-public.yaml" download="openapi-public.yaml" prefetch="false" />
</Cards>

The same spec is served at stable URLs for tools and agents:

* YAML: [`https://docs.carecycle.ai/openapi.yaml`](/openapi.yaml)
* JSON: [`https://docs.carecycle.ai/openapi.json`](/openapi.json)

Every page in these docs is also available as Markdown: add `.md` to its URL
(for example, [`/docs/api-reference/errors.md`](/docs/api-reference/errors.md)).
An index of all pages is at [`/llms.txt`](/llms.txt).