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_contracts.subpackage_contracts/v3 API

The subpackage_contracts.subpackage_contracts/v3 API from Candid Health — 6 operation(s) for subpackage_contracts.subpackage_contracts/v3.

Documentation Provider Profile APIs.io OpenAPI GitHub

Candid Health subpackage_contracts.subpackage_contracts/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_contracts.subpackage_contracts/v3. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

11 operations 6 paths 5 schemas 2 DELETE4 GET2 PATCH3 POST

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_contracts.subpackage_contracts/v3 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 11

Across 6 paths, the API surfaces 11 operations — 2 DELETE, 4 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

subpackage_contracts.subpackage_contracts/v3 11
GET
/api/contracts/v3/{contract_id}
Get contract
get 2 params → 200404
DELETE
/api/contracts/v3/{contract_id}
Delete contract
delete 2 params → 200422
PATCH
/api/contracts/v3/{contract_id}
Update contract
update 2 params body → 200422
GET
/api/contracts/v3
Get all contracts
get-multi 11 params → 200
POST
/api/contracts/v3
Create contract
create 1 param body → 200
GET
/api/contracts/v3/{contract_id}/providers
Get contract providers
get-contract-providers 4 params → 200404422
POST
/api/contracts/v3/{contract_id}/providers
Add providers to contract
add-contract-providers 2 params body → 200404422
DELETE
/api/contracts/v3/{contract_id}/providers
Remove providers from contract
remove-contract-providers 2 params body → 200404422
GET
/api/contracts/v3/{contract_id}/providers/credentialing
Get contract provider credentialing spans
get-contract-provider-credentialing-spans 4 params → 200404422
POST
/api/contracts/v3/{contract_id}/service-facilities
Create contract service facility
create-contract-service-facility 2 params body → 200422
PATCH
/api/contracts/v3/{contract_id}/service-facilities/{contract_service_facility_id}
Update contract service facility
update-contract-service-facility 3 params body → 200422

Schemas 5

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

type_commons:State
string
type_commons:EntityNotFoundErrorMessage
object
1 property 1 required
type_commons:PageToken
string
type_commons:UnprocessableEntityErrorMessage
object
1 property
type_commons:SortDirection
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-subpackage-contracts-subpackage-contracts-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_credentialing.subpackage_credentialing/v2 API
AE Profile APIs.io
#subpackage_contracts.subpackage_contracts/v3
← Back to C APIs
API Details
ID
candid-health:candid-health-subpackage-contracts-subpackage-contracts-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