Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Candid Health Events API

Scan and retrieve billing lifecycle events.

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

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

This API exposes 2 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.joincandidhealth.com/api.

2 operations 2 paths 2 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.joincandidhealth.com/api
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Candid Health Events API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth bearer token obtained from POST /auth/v2/token. Send as Authorization: Bearer .

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Events 2

Scan and retrieve billing lifecycle events.

GET
/events/v1
Scan billing lifecycle events.
scanEvents 3 params → 200
GET
/events/v1/{event_id}
Get an event.
getEvent 1 param → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Event (5 properties), EventPage (2 properties). Each schema is shown below with its type and property counts.

EventPage
object
2 properties
Event
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candidhealth-events-api-openapi.yml Raw ↑

Other APIs Candid Health publishes across the network.

Candid Health Auth API
Candid Health Charge Capture API
Candid Health Eligibility API
Candid Health Encounters API
Candid Health Fee Schedules API
Candid Health Insurance Adjudications API
Candid Health Payers API