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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Candid Health

Candid Health subpackage_fee-schedules.subpackage_fee-schedules/v3 API

The subpackage_fee-schedules.subpackage_fee-schedules/v3 API from Candid Health — 11 operation(s) for subpackage_fee-schedules.subpackage_fee-schedules/v3.

Documentation Provider Profile APIs.io OpenAPI GitHub

Candid Health subpackage_fee-schedules.subpackage_fee-schedules/v3 API is one of 54 APIs that Candid Health publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include subpackage_fee-schedules.subpackage_fee-schedules/v3. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 12 operations across 11 paths, and defines 11 schemas. It is described by OpenAPI 3.1.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.

12 operations 11 paths 11 schemas 1 DELETE7 GET3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Candid Health subpackage_fee-schedules.subpackage_fee-schedules/v3 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 12

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

subpackage_fee-schedules.subpackage_fee-schedules/v3 12
GET
/api/fee-schedules/v3/service-line/{service_line_id}/match
Get Match
get-match 2 params → 200404422
GET
/api/fee-schedules/v3/service-line/{service_line_id}/match/{rate_id}
Test Match
test-match 3 params → 200404422
GET
/api/fee-schedules/v3
Get Multi
get-multi 14 params → 200
POST
/api/fee-schedules/v3
Upload a fee schedule (a collection of rates)
upload-fee-schedule 1 param body → 200422
GET
/api/fee-schedules/v3/unique-dimension-values
Get Unique Values For Dimension
get-unique-values-for-dimension 14 params → 200
GET
/api/fee-schedules/v3/{rate_id}/history
Get Rate History
get-rate-history 2 params → 200404
DELETE
/api/fee-schedules/v3/{rate_id}/{version}
Delete a rate
delete-rate 3 params → 200404409
GET
/api/fee-schedules/v3/payer-threshold/default
Get Payer Thresholds Default
get-payer-thresholds-default 1 param → 200
GET
/api/fee-schedules/v3/payer-threshold
Get Payer Thresholds
get-payer-thresholds 2 params → 200
PUT
/api/fee-schedules/v3/payer-threshold/{payer_uuid}
Set Payer Threshold
set-payer-threshold 2 params body → 200404
POST
/api/fee-schedules/v3/hard-delete
Hard delete rates
hard-delete-rates 1 param body → 200
POST
/api/fee-schedules/v3/hard-delete-by-ids
Hard delete rates by IDs
hard-delete-rates-by-ids 1 param body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are type_commons:EntityNotFoundErrorMessage (1 property), type_commons:EntityConflictErrorMessage (1 property). Each schema is shown below with its type and property counts.

type_commons:State
string
type_commons:EntityConflictErrorMessage
object
1 property 1 required
type_commons:EntityNotFoundErrorMessage
object
1 property 1 required
type_commons:PageToken
string
type_commons:PayerPlanGroupId
string
type_commons:NetworkType
string
type_commons:ErrorMessage
string
type_commons:ProcedureModifier
string
type_commons:FacilityTypeCode
string
Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here: https://www.…
type_commons:RateId
string
type_commons:ServiceLineId
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-subpackage-fee-schedules-subpackage-fee-schedules-v3-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 subpackage_auth.subpackage_auth/default API
AE Profile APIs.io
Candid Health subpackage_billing-notes.subpackage_billing-notes/v2 API
AE Profile APIs.io
Candid Health subpackage_charge-capture-bundles.subpackage_charge-capture-bundles/v1 API
AE Profile APIs.io
Candid Health subpackage_charge-capture.subpackage_charge-capture/v1 API
AE Profile APIs.io
Candid Health subpackage_contracts.subpackage_contracts/v2 API
AE Profile APIs.io
Candid Health subpackage_contracts.subpackage_contracts/v3 API
AE Profile APIs.io
#subpackage_fee-schedules.subpackage_fee-schedules/v3
← Back to C APIs
API Details
ID
candid-health:candid-health-subpackage-fee-schedules-subpackage-fee-schedules-v3-api
Base URL
https://api.joincandidhealth.com
Docs
https://docs.joincandidhealth.com/api-reference/eligibility/v-2
Provider
Candid Health
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network