How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Candid Health

Candid Health Patients API

The Patients API from Candid Health — 11 operation(s) for patients.

Documentation Provider Profile APIs.io OpenAPI GitHub

Candid Health Patients API is one of 53 APIs that Candid Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Patients. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 14 operations across 11 paths, and defines 92 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 10 base URLs: https://pre-api.joincandidhealth.com, https://pre-api-staging.joincandidhealth.com, https://sandbox-pre-api.joincandidhealth.com, https://staging-pre-api.joincandidhealth.com, http://localhost:4000, https://api.joincandidhealth.com, https://api-staging.joincandidhealth.com, https://sandbox-api.joincandidhealth.com, https://staging-api.joincandidhealth.com, http://localhost:5050.

14 operations 11 paths 92 schemas 1 DELETE9 GET1 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.joincandidhealth.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Candid Health Patients API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 1 DELETE, 9 GET, 1 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Patients 14
POST
/patients/v1
Create
create 2 params body → 200409
GET
/patients/v1
Search
search 3 params → 200
POST
/patients/v1/with_mrn
Create With Mrn
create_with_mrn 2 params body → 200400409
GET
/patients/v1/get_multi
Get Multi
get_multi 7 params → 200
GET
/patients/v1/search_providers
Search Providers
search_providers 2 params → 200
GET
/patients/v1/{id}
Get
get 2 params → 200404
GET
/patients/v1/mrn/{mrn}
Get By Mrn
get_by_mrn 2 params → 200404
GET
/patients/v1/{id}/history
Get History
get_history 2 params → 200404
GET
/patients/v1/{id}/snapshot
Get Coverage Snapshot
get_coverage_snapshot 3 params → 200404
GET
/patients/v1/{id}/eligibility-timeline
Get Eligibility Timeline
get_eligibility_timeline 7 params → 200
PUT
/patients/v1/{id}/{version}
Update
update 3 params body → 200404409
DELETE
/patients/v1/{id}/{version}
Deactivate
deactivate 3 params → 200404409
PATCH
/patients/v1/{id}/{version}
Reactivate
reactivate 3 params → 200404409
GET
/patients/v1/updates/scan
Scan
scan 3 params → 200

Schemas 92

The contract defines 92 schemas that model the data the API accepts and returns. The most detailed are type_pre-encounter_patients_v1_Patient (52 properties), type_pre-encounter_patients_v1_MutablePatientWithMrn (46 properties), type_pre-encounter_patients_v1_MutablePatient (45 properties), type_pre-encounter_coverages_v1_Coverage (18 properties). Each schema is shown below with its type and property counts.

type_pre-encounter_common_Period
object
2 properties
type_pre-encounter_common_PayerId
string
The unique identifier for a Payer in the database
type_pre-encounter_patients_v1_ElectronicCommunicationConsent
object
Granular consent for electronic communication channels.
2 properties
type_pre-encounter_patients_v1_Patient
object
A patient object with immutable server-owned properties.
52 properties 17 required
type_pre-encounter_common_Relationship
string
type_pre-encounter_patients_v1_CoveragesForRelatedCauses
object
Additional coverages for the patient applicable to related causes such as Auto or Workers Comp
1 property 1 required
type_pre-encounter_common_HumanName
object
5 properties 3 required
type_pre-encounter_patients_v1_EligibilityTimelineEvent
object
A single eligibility audit event.
9 properties 7 required
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckErrorDetails
object
This object is our fern representation of Stedi's EligbilityCheckError object from their API.
6 properties
type_pre-encounter_common_Gender
string
type_pre-encounter_coverages_v1_InsurancePlan
object
13 properties 3 required
type_pre-encounter_patients_v1_AuthorizationUnit
string
type_pre-encounter_common_AppointmentId
string
The unique identifier for an Appointment.
type_pre-encounter_coverages_v1_NonCoveredDetail
object
6 properties 4 required
type_pre-encounter_patients_v1_MutablePatientWithMrn
object
46 properties 11 required
type_pre-encounter_coverages_v1_ServiceCoverage
object
5 properties 1 required
type_pre-encounter_patients_v1_ExternalProvenance
object
Information about the upstream system that owns this patient data.
2 properties 2 required
type_pre-encounter_coverages_v1_ServiceTypeCode
string
Code identifying the type of service or benefit within a specific insurance policy (X12 008010 Element 1365)
type_pre-encounter_patients_v1_Contact
object
6 properties 4 required
type_pre-encounter_common_PayerPlanGroupId
string
The unique identifier for a PayerPlanGroup in the database
type_pre-encounter_patients_v1_MutablePatient
object
An object representing patient demographics information.
45 properties 10 required
type_pre-encounter_patients_v1_InferredPatientMetadata
object
2 properties 2 required
type_pre-encounter_patients_v1_OriginationDetail
object
4 properties 1 required
type_pre-encounter_coverages_v1_Subscriber
object
5 properties 2 required
type_pre-encounter_common_Sex
string
type_pre-encounter_patients_v1_AdvancedDirective
string
type_pre-encounter_common_CanonicalNonInsurancePayerAssociation
object
4 properties 1 required
type_pre-encounter_patients_v1_PatientPage
object
4 properties 2 required
type_pre-encounter_coverages_v1_Coverage
object
A coverage object with immutable server-owned properties.
18 properties 12 required
type_pre-encounter_coverages_v1_CoverageStatus
string
enum to represent the statuses defined at https://build.fhir.org/valueset-fm-status.html
type_pre-encounter_coverages_v1_LatestEligibilityCheck
object
A type to represent the latest eligibility check status of a coverage.
4 properties 3 required
type_pre-encounter_patients_v1_FilingOrder
object
The patient's active coverages, in order of primary, secondary, etc.
1 property 1 required
type_pre-encounter_patients_v1_ReferralSource
string
type_pre-encounter_coverages_v1_CoverageBenefits
object
6 properties
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckMetadata
object
5 properties 5 required
type_pre-encounter_common_PageToken
string
A token that can be used to retrieve the next or previous page of results
type_pre-encounter_common_CanonicalProviderId
string
The unique identifier for a provider configured in the Candid system
type_pre-encounter_coverages_v1_BenefitsRelatedEntity
object
5 properties
type_pre-encounter_patients_v1_EligibilityTimelinePage
object
4 properties 2 required
type_pre-encounter_coverages_v1_BenefitType
string
type_pre-encounter_common_CanonicalServiceFacilityId
string
The unique identifier for a service facility configured in the Candid system
type_pre-encounter_common_ExternalProviderType
string
type_pre-encounter_common_NoteId
string
The unique identifier for a Note.
type_pre-encounter_common_ErrorBase4xx
object
2 properties 1 required
type_pre-encounter_patients_v1_Guarantor
object
5 properties 2 required
type_pre-encounter_common_OrganizationId
string
The unique identifier for an Organization in the database
type_pre-encounter_common_Ethnicity
string
type_pre-encounter_common_PatientServiceFacility
object
Represents a canonical service facility attached to a patient or patient dependent object
1 property 1 required
type_pre-encounter_coverages_v1_CarveOutType
string
type_pre-encounter_patients_v1_Authorization
object
14 properties 5 required
type_pre-encounter_common_ExternalIdentifier
object
An external identifier for a patient
3 properties 2 required
type_pre-encounter_common_TagId
string
The unique identifier for a Tag.
type_pre-encounter_common_SortDirection
string
type_pre-encounter_patients_v1_DoNotInvoiceReason
string
type_pre-encounter_common_NameUse
string
type_pre-encounter_patients_v1_ReferralType
string
type_pre-encounter_patients_v1_Referral
object
9 properties 2 required
type_pre-encounter_common_ContactPoint
object
3 properties 2 required
type_pre-encounter_patients_v1_ReferralUnit
string
type_pre-encounter_common_VersionConflictErrorBody
object
3 properties 1 required
type_pre-encounter_common_CoverageId
string
The unique identifier for a Coverage in the database
type_pre-encounter_common_Address
object
8 properties 6 required
type_pre-encounter_common_SexualOrientation
string
type_pre-encounter_coverages_v1_CoverageDetails
object
5 properties 4 required
type_pre-encounter_eligibilityChecks_v1_EligibilityStatus
string
enum to represent the status of a patient's coverage
type_pre-encounter_common_CanonicalClinicalTrialId
string
The unique identifier for a clinical trial configured in the Candid system
type_pre-encounter_coverages_v1_ServiceCoverageDetails
object
5 properties
type_pre-encounter_patients_v1_MaritalStatus
string
type_pre-encounter_coverages_v1_CoverageValueUnit
string
type_pre-encounter_coverages_v1_RelatedEntityContact
object
2 properties
type_pre-encounter_common_ExternalProvider
object
11 properties 2 required
type_pre-encounter_common_ContactPointUse
string
type_pre-encounter_common_CanonicalClinicalTrialAssociation
object
3 properties 1 required
type_pre-encounter_coverages_v1_CoverageValue
object
4 properties
type_pre-encounter_common_AddressUse
string
type_pre-encounter_common_DisabilityStatus
string
type_pre-encounter_eligibilityChecks_v1_EligibilityCheckStatus
string
enum to represent the status of an eligibility checks
type_pre-encounter_coverages_v1_PlanCoverage
object
4 properties
type_pre-encounter_patients_v1_PatientSortField
string
The field to order by. Valid values are either keys on the patient object or a special ordering "similarname: " (Ex: similarname:John). Similar name ordering u…
type_pre-encounter_coverages_v1_PlanCoverageDetails
object
9 properties
type_pre-encounter_common_Race
string
type_pre-encounter_common_UserId
string
The unique identifier for a User in the database
type_pre-encounter_coverages_v1_CoverageCarveOut
object
8 properties 4 required
type_pre-encounter_coverages_v1_InsuranceTypeCode
string
Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336)
type_pre-encounter_coverages_v1_NetworkType
string
type_pre-encounter_patients_v1_EligibilityAuditEventType
string
type_pre-encounter_common_AdditionalPayerInformation
object
4 properties
type_pre-encounter_patients_v1_PatientCoverageSnapshot
object
5 properties 2 required
type_pre-encounter_common_CanonicalNonInsurancePayerId
string
The unique identifier for a non-insurance payer configured in the Candid system
type_pre-encounter_patients_v1_SpecializationCategory
string
type_pre-encounter_common_PatientId
string
The unique identifier for a Patient
type_pre-encounter_coverages_v1_CoverageLevel
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-patients-api-openapi.yml Raw ↑

Other APIs Candid Health publishes across the network.

Candid Health Patient Collections API
AE Profile APIs.io
Candid Health Charge Capture API
AE Profile APIs.io
Candid Health Exports API
AE Profile APIs.io
Candid Health Credentialing API
AE Profile APIs.io
Candid Health Auth API
AE Profile APIs.io
Candid Health Default API
AE Profile APIs.io
Candid Health Diagnoses API
AE Profile APIs.io
Candid Health Appointments API
AE Profile APIs.io
Candid Health Billing Notes API
AE Profile APIs.io
Candid Health Charge Capture Claim Creation API
AE Profile APIs.io
Candid Health Charge Captures API
AE Profile APIs.io
Candid Health Contracts API
AE Profile APIs.io
#Patients
← Back to C APIs
API Details
ID
candid-health:candid-health-patients-api
Base URL
https://api.joincandidhealth.com
Docs
https://docs.joincandidhealth.com/api-reference/patient-collections
Provider
Candid Health
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=candid-health-patients-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/candid-health-patients-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Candid Health Patients API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.