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 Appointments API

The Appointments API from Candid Health — 7 operation(s) for appointments.

Documentation Provider Profile APIs.io OpenAPI GitHub

Candid Health Appointments 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 Appointments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 8 operations across 7 paths, and defines 71 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.

8 operations 7 paths 71 schemas 1 DELETE5 GET1 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 Appointments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 8

Across 7 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Appointments 8
POST
/appointments/v1
Create
create 1 param body → 200404409
GET
/appointments/v1/visits
Get Visits
get_visits 6 params → 200400
GET
/appointments/v1/visits/counts
Get Counts
get_counts 2 params → 200400
GET
/appointments/v1/{id}
Get
get 2 params → 200404
GET
/appointments/v1/{id}/history
Get History
get_history 2 params → 200404
PUT
/appointments/v1/{id}/{version}
Update
update 3 params body → 200404409
DELETE
/appointments/v1/{id}/{version}
Deactivate
deactivate 3 params → 200404409
GET
/appointments/v1/updates/scan
Scan
scan 2 params → 200

Schemas 71

The contract defines 71 schemas that model the data the API accepts and returns. The most detailed are type_pre-encounter_patients_v1_MutablePatientWithMrn (46 properties), type_pre-encounter_appointments_v1_Appointment (24 properties), type_pre-encounter_appointments_v1_MutableAppointment (18 properties), type_pre-encounter_patients_v1_Authorization (14 properties). Each schema is shown below with its type and property counts.

type_pre-encounter_common_Period
object
2 properties
type_pre-encounter_patients_v1_Authorization
object
14 properties 5 required
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_common_CanonicalNonInsurancePayerAssociation
object
4 properties 1 required
type_pre-encounter_common_ExternalIdentifier
object
An external identifier for a patient
3 properties 2 required
type_pre-encounter_common_FilterQueryString
string
A serialized list of filters separated by commas indicating filters to apply. Each filter is of the form 'path:operator:value'. Example: 'patient.mrn|eq|12345'…
type_pre-encounter_common_TagId
string
The unique identifier for a Tag.
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_appointments_v1_Service
object
2 properties
type_pre-encounter_common_Relationship
string
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_common_SortDirection
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_lists_v1_SortFieldString
string
The field to order by. Valid values are either keys on the list item object or a special ordering "similarname: " (Ex: similarname:John). Similar name ordering…
type_pre-encounter_patients_v1_ReferralSource
string
type_pre-encounter_appointments_v1_UniversalServiceIdentifier
string
type_pre-encounter_common_HumanName
object
5 properties 3 required
type_pre-encounter_common_ExternalProvider
object
11 properties 2 required
type_pre-encounter_appointments_v1_Visit
object
A visit is a collection of appointments that occur on the same day.
11 properties 5 required
type_pre-encounter_patients_v1_DoNotInvoiceReason
string
type_pre-encounter_common_ContactPointUse
string
type_pre-encounter_common_CanonicalClinicalTrialAssociation
object
3 properties 1 required
type_pre-encounter_appointments_v1_NotReadyReason
string
The reason an appointment is NOTREADY. Only set when status is NOTREADY. All values except MANUAL are set by the automated eligibility check; MANUAL is set by…
type_pre-encounter_common_AddressUse
string
type_pre-encounter_common_DisabilityStatus
string
type_pre-encounter_common_Gender
string
type_pre-encounter_common_NameUse
string
type_pre-encounter_common_Race
string
type_pre-encounter_patients_v1_AuthorizationUnit
string
type_pre-encounter_patients_v1_ReferralType
string
type_pre-encounter_common_UserId
string
The unique identifier for a User in the database
type_pre-encounter_patients_v1_Referral
object
9 properties 2 required
type_pre-encounter_common_AppointmentId
string
The unique identifier for an Appointment.
type_pre-encounter_common_PageToken
string
A token that can be used to retrieve the next or previous page of results
type_pre-encounter_patients_v1_MutablePatientWithMrn
object
46 properties 11 required
type_pre-encounter_common_CanonicalProviderId
string
The unique identifier for a provider configured in the Candid system
type_pre-encounter_common_ContactPoint
object
3 properties 2 required
type_pre-encounter_appointments_v1_AppointmentStatus
string
type_pre-encounter_patients_v1_ExternalProvenance
object
Information about the upstream system that owns this patient data.
2 properties 2 required
type_pre-encounter_appointments_v1_ReadySource
string
Indicates how this appointment's status was marked as READY - MANUAL or MACHINE.
type_pre-encounter_patients_v1_ReferralUnit
string
type_pre-encounter_common_CanonicalServiceFacilityId
string
The unique identifier for a service facility configured in the Candid system
type_pre-encounter_common_AdditionalPayerInformation
object
4 properties
type_pre-encounter_patients_v1_Contact
object
6 properties 4 required
type_pre-encounter_appointments_v1_MutableAppointment
object
An object representing a appointment.
18 properties 4 required
type_pre-encounter_common_VersionConflictErrorBody
object
3 properties 1 required
type_pre-encounter_appointments_v1_VisitsPage
object
4 properties 2 required
type_pre-encounter_common_PayerPlanGroupId
string
The unique identifier for a PayerPlanGroup in the database
type_pre-encounter_common_CoverageId
string
The unique identifier for a Coverage in the database
type_pre-encounter_appointments_v1_Appointment
object
An appointment object with immutable server-owned properties.
24 properties 10 required
type_pre-encounter_common_ExternalProviderType
string
type_pre-encounter_common_NoteId
string
The unique identifier for a Note.
type_pre-encounter_appointments_v1_AppointmentWorkQueue
string
type_pre-encounter_appointments_v1_CountsResponse
object
1 property
type_pre-encounter_common_Address
object
8 properties 6 required
type_pre-encounter_common_SexualOrientation
string
type_pre-encounter_common_CanonicalNonInsurancePayerId
string
The unique identifier for a non-insurance payer configured in the Candid system
type_pre-encounter_common_ErrorBase4xx
object
2 properties 1 required
type_pre-encounter_patients_v1_Guarantor
object
5 properties 2 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_patients_v1_SpecializationCategory
string
type_pre-encounter_common_Sex
string
type_pre-encounter_common_CanonicalClinicalTrialId
string
The unique identifier for a clinical trial configured in the Candid system
type_pre-encounter_common_PatientId
string
The unique identifier for a Patient
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_patients_v1_AdvancedDirective
string
type_pre-encounter_patients_v1_MaritalStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-appointments-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 Patients 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 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
#Appointments
← Back to C APIs
API Details
ID
candid-health:candid-health-appointments-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-appointments-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/candid-health-appointments-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 Appointments 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.