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

Candid Health Payer Plan Groups API

The Payer Plan Groups API from Candid Health — 2 operation(s) for payer plan groups.

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

This API exposes 5 operations across 2 paths, and defines 18 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.

5 operations 2 paths 18 schemas 2 GET1 PATCH1 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 Payer Plan Groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 5

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

Payer Plan Groups 5
GET
/api/payer-plan-groups/v1
Get payer plans
getMulti 13 params → 200403422
POST
/api/payer-plan-groups/v1
Create a payer plan
create 1 param body → 200404422
GET
/api/payer-plan-groups/v1/{payer_plan_group_id}
Get payer plan
get 2 params → 200403404
PUT
/api/payer-plan-groups/v1/{payer_plan_group_id}
Update payer plan
update 2 params body → 200403404422
PATCH
/api/payer-plan-groups/v1/{payer_plan_group_id}
Delete payer plan
deactivate 2 params → 200403404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are type_payers_v3_Payer (8 properties), type_payer-plan-groups_v1_PayerPlanGroup (7 properties), type_commons_StreetAddressLongZip (6 properties), type_payer-plan-groups_v1_MutablePayerPlanGroup (3 properties). Each schema is shown below with its type and property counts.

type_commons_EntityNotFoundErrorMessage
object
1 property 1 required
type_commons_PageToken
string
type_commons_PayerPlanGroupId
string
type_commons_UnauthorizedErrorMessage
object
1 property
type_commons_OrganizationId
string
type_commons_StreetAddressLongZip
object
6 properties 5 required
type_payer-plan-groups_v1_PayerPlanGroupAlreadyExistsError
object
2 properties 2 required
type_payer-plan-groups_v1_PayerPlanGroup
object
7 properties 7 required
type_commons_SourceOfPaymentCode
string
type_payer-plan-groups_v1_PayerPlanGroupPage
object
3 properties 1 required
type_payers_v3_Payer
object
8 properties 3 required
type_payers_v3_PayerUuid
string
type_payer-plan-groups_v1_PayerPlanGroupSortField
string
type_payer-plan-groups_v1_MutablePayerPlanGroup
object
3 properties 3 required
type_payers_v3_PayerId
string
type_commons_State
string
type_commons_SortDirection
string
type_commons_UnprocessableEntityErrorMessage
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-payer-plan-groups-api-openapi.yml Raw ↑

Other APIs Candid Health publishes across the network.

Candid Health Patient Collections API
Candid Health Charge Capture API
Candid Health Exports API
Candid Health Patients API
Candid Health Credentialing API
Candid Health Auth API
Candid Health Default API
Candid Health Diagnoses API
Candid Health Appointments API
Candid Health Billing Notes API
Candid Health Charge Capture Claim Creation API
Candid Health Charge Captures API
Where this information came from

This is an independent, third-party profile of Candid Health Payer Plan Groups 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.