> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Candid Health

> How to set up the Candid Health connector, plus the actions that are available.

![Candid Health](https://stackone-logos.com/api/candid-health/filled/svg)

Betav1.3.0[See changelog](https://docs.stackone.com/connectors/candidhealth/changelog.md)

[51 actions](#actions) · 1 auth method

Healthcare
Billing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/candidhealth/guides/connector-profile/oauth-2-0.md)
>
> Requires a Client ID and Client Secret issued by Candid Health during onboarding. Separate credentials are required per...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/candidhealth/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

51 actions

ActionDescription

Create Appointment`candidhealth_appointments_v1_create`

Create a pre-encounter appointment for a patient with scheduling and eligibility metadata.

List Visits`candidhealth_appointments_v1_get_visits`

List appointment visits within a date range with pagination and sorting.

Get Appointment`candidhealth_appointments_v1_get`

Retrieve a single appointment by its Candid appointment ID.

Update Appointment`candidhealth_appointments_v1_update`

Update an appointment using optimistic concurrency via the next version number.

Create Charge Capture`candidhealth_charge_captures_v1_create`

Create a charge capture holding pre-billing charge data before encounter submission.

List Charge Captures`candidhealth_charge_captures_v1_get_all`

List charge captures filtered by patient, bundle, status, service dates, or provider.

Update Charge Capture`candidhealth_charge_captures_v1_update`

Update charge capture data or bundle assignment before aggregation.

Get Charge Capture`candidhealth_charge_captures_v1_get`

Retrieve a single charge capture by its Candid charge capture ID.

Create Coverage`candidhealth_coverages_v1_create`

Create an insurance coverage record for a patient with payer, plan, subscriber, and benefits data.

Update Coverage`candidhealth_coverages_v1_update`

Update a coverage record using optimistic concurrency via the next version number.

List Coverages`candidhealth_coverages_v1_get_multi_paginated`

List coverages filtered by patient, payer, and status with cursor pagination.

Get Coverage`candidhealth_coverages_v1_get`

Retrieve a single coverage record by its Candid coverage ID.

Create Diagnosis`candidhealth_diagnoses_v2_create`

Attach an ICD diagnosis code to an existing encounter.

Update Diagnosis`candidhealth_diagnoses_v2_update`

Update an existing diagnosis code, code type, name, or POA indicator.

Run Eligibility Check`candidhealth_eligibility_checks_v1_post`

Submit a real-time 270/271 eligibility check to a payer via Stedi.

Submit Eligibility Batch`candidhealth_eligibility_checks_v1_batch`

Submit a batch of eligibility checks to payers for asynchronous processing.

List Encounters`candidhealth_encounters_v4_get_all`

List professional encounters filtered by status, dates, patient, provider, payer, and more.

Create Encounter`candidhealth_encounters_v4_create`

Create a professional encounter (claim) with patient, providers, diagnoses, and service lines.

Get Encounter`candidhealth_encounters_v4_get`

Retrieve a single encounter (claim) with its providers, diagnoses, and service lines.

Update Encounter`candidhealth_encounters_v4_update`

Update fields on an existing encounter (claim), including status, providers, and billing metadata.

Get Claim Exports`candidhealth_exports_v3_get_exports`

Fetch CSV export files of claim version changes within a date window.

List Import Invoices`candidhealth_import_invoice_v1_get_multi`

List invoices imported from a third-party invoicing system, filtered by patient, encounter, note, due date, or status.

Get Insurance Adjudication`candidhealth_insurance_adjudications_v1_get`

Retrieve a single insurance adjudication (ERA/EOB posting) by its Candid ID.

List Insurance Refunds`candidhealth_insurance_refunds_v1_get_multi`

List insurance refunds filtered by payer, service line, claim, or billing provider.

Create Insurance Refund`candidhealth_insurance_refunds_v1_create`

Post an insurance refund with allocations to service lines, claims, or billing provider unattributed cash.

Get Insurance Refund`candidhealth_insurance_refunds_v1_get`

Retrieve a single insurance refund and its allocations by refund ID.

Update Insurance Refund`candidhealth_insurance_refunds_v1_update`

Update an insurance refund's amount, timestamp, notes, or allocations.

List Patient Payments`candidhealth_patient_payments_v4_get_multi`

List patient payments filtered by patient, claim, service line, billing provider, invoice, or payment source.

Create Patient Payment`candidhealth_patient_payments_v4_create`

Record a patient payment and allocate it to service lines, claims, a billing provider, an appointment, or leave it unatt...

Get Patient Payment`candidhealth_patient_payments_v4_get`

Retrieve a single patient payment and its allocations by patient payment ID.

Update Patient Payment`candidhealth_patient_payments_v4_update`

Update a patient payment's timestamp, note, or invoice.

Delete Patient Payment`candidhealth_patient_payments_v4_delete`

Delete a patient payment by patient payment ID.

Create Patient`candidhealth_patients_v1_create`

Create a pre-encounter patient with demographics, contacts, guarantors, and other administrative data.

Search Patients`candidhealth_patients_v1_search`

Search patients by MRN or other identifier fields.

List Patients`candidhealth_patients_v1_get_multi`

List patients with cursor pagination, sort, filters, and free-text search.

Get Patient`candidhealth_patients_v1_get`

Retrieve a single patient by their Candid patient ID.

Update Patient`candidhealth_patients_v1_update`

Update a patient record using optimistic concurrency via the next version number.

Deactivate Patient`candidhealth_patients_v1_deactivate`

Deactivate (soft-delete) a patient using optimistic concurrency via the next version number.

Get Payer`candidhealth_payers_v4_get`

Retrieve a single payer from Candid's canonical payer list by its UUID.

List Payers`candidhealth_payers_v4_get_all`

List all payers on Candid's canonical payer list with optional name search.

Create Service Line`candidhealth_service_lines_v2_create`

Add a service line (CPT/HCPCS code) with charges and diagnosis pointers to an encounter.

Update Service Line`candidhealth_service_lines_v2_update`

Update an existing service line's code, modifiers, units, charge, or diagnosis pointers.

Delete Service Line`candidhealth_service_lines_v2_delete`

Remove a service line from its encounter by service line ID.

List Tasks`candidhealth_tasks_v3_get_multi`

List billing operations tasks filtered by status, category, assignee, or encounter.

Create Task`candidhealth_tasks_v3_create`

Create a billing operations task tied to an encounter with type, category, and assignee.

Get Task`candidhealth_tasks_v3_get`

Retrieve a single task with its notes, status history, and encounter reference.

Update Task`candidhealth_tasks_v3_update`

Update a task's status, assignee, notes, or blocking reasons.

List Write-Offs`candidhealth_write_offs_v1_get_multi`

List write-offs filtered by payer, claim, service line, billing provider, or account type.

Create Write-Offs`candidhealth_write_offs_v1_create`

Post one or more write-offs applied to a service line, claim, or billing provider.

Get Write-Off`candidhealth_write_offs_v1_get`

Retrieve a single write-off record by its Candid write-off ID.

Revert Write-Off`candidhealth_write_offs_v1_revert`

Reverse a previously posted write-off, restoring the balance on its target.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.