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

The Contracts API from Candid Health — 8 operation(s) for contracts.

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

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

16 operations 8 paths 61 schemas 3 DELETE6 GET3 PATCH4 POST

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

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 16

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

Contracts 16
GET
/api/contracts/v2/{contract_id}
Get contract
get 3 params → 200404
DELETE
/api/contracts/v2/{contract_id}
Delete contract
delete 2 params → 200422
PATCH
/api/contracts/v2/{contract_id}
Update contract
update 2 params body → 200422
GET
/api/contracts/v2
Get all contracts
get_multi 10 params → 200
POST
/api/contracts/v2
Create contract
create 1 param body → 200
GET
/api/contracts/v3/{contract_id}
Get contract
getApiContractsV3ByContractId 2 params → 200404
DELETE
/api/contracts/v3/{contract_id}
Delete contract
deleteApiContractsV3ByContractId 2 params → 200422
PATCH
/api/contracts/v3/{contract_id}
Update contract
patchApiContractsV3ByContractId 2 params body → 200422
GET
/api/contracts/v3
Get all contracts
getApiContractsV3 11 params → 200
POST
/api/contracts/v3
Create contract
postApiContractsV3 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 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are type_organization-providers_v2_OrganizationProvider (17 properties), type_organization-providers_v3_OrganizationProviderV2 (15 properties), type_contracts_v2_ContractWithProviders (13 properties), type_credentialing_v2_ProviderCredentialingSpan (13 properties). Each schema is shown below with its type and property counts.

type_contracts_v3_ContractServiceFacility
object
4 properties 4 required
type_commons_PageToken
string
type_contracts_v3_RenderingProviderid
string
type_organization-providers_v2_OrganizationProvider
object
17 properties 7 required
type_organization-providers_v2_ProviderType
string
type_contracts_v3_ContractId
string
type_credentialing_v2_ProviderCredentialingSpanId
string
type_contracts_v3_ContractUpdateUnion
type_commons_OrganizationId
string
type_contracts_v2_ContractingProviderId
string
type_contracts_v2_ContractInvalidExpirationDateError
object
1 property 1 required
type_contracts_v2_ContractStatus
string
type_organization-providers_v2_LicenseType
string
type_contracts_v2_ContractId
string
type_contracts_v3_ContractType
string
type_credentialing_v2_CredentialingSpanStatus
string
Stage of a credentialing span in the credentialing workflow.
type_contracts_v2_ContractIsLinkedToFeeScheduleError
object
1 property 1 required
type_contracts_v3_ContractProviderCredentialingPage
object
3 properties 1 required
type_organization-providers_v3_OrganizationProviderV2
object
15 properties 7 required
type_contracts_v2_Contract
object
12 properties 9 required
type_commons_UnprocessableEntityErrorMessage
object
1 property
type_identifiers_IdentifierValue
type_commons_EntityNotFoundErrorMessage
object
1 property 1 required
type_commons_DateRangeOptionalEnd
object
2 properties 1 required
type_commons_Regions
type_contracts_v2_RegionsUpdate
type_identifiers_IdentifierCode
string
type_contracts_v3_ContractWithProvidersUnion
type_identifiers_IdentifierId
string
type_contracts_v3_ContractCreateUnion
type_contracts_v2_AuthorizedSignatory
object
6 properties
type_contracts_v2_AuthorizedSignatoryUpdate
type_contracts_v2_InsuranceTypes
type_contracts_v3_ContractServiceFacilityId
string
type_contracts_v3_ContractProviderCredentialing
object
A rendering provider with their credentialing spans scoped to the contract's contracting provider and payer.
2 properties 2 required
type_contracts_v2_ContractSortField
string
type_organization-providers_v2_OrganizationProviderId
string
type_commons_SortDirection
string
type_identifiers_Identifier
object
4 properties 3 required
type_contracts_v2_RenderingProviderid
string
type_contracts_v3_ContractUnion
type_contracts_v3_ContractProvidersPage
object
3 properties 1 required
type_contracts_v3_ContractingProviderId
string
type_contracts_v2_ContractsPage
object
3 properties 1 required
type_contracts_v3_ContractServiceFacilityBase
object
2 properties 2 required
type_payers_v3_Payer
object
8 properties 3 required
type_commons_State
string
type_contracts_v3_ContractProviderCount
object
1 property 1 required
type_credentialing_v2_ProviderCredentialingSpan
object
13 properties 8 required
type_contracts_v3_AddContractProvidersResponse
object
3 properties 3 required
type_contracts_v2_ContractWithProviders
object
13 properties 10 required
type_organization-providers_v2_AddressType
string
type_commons_InsuranceTypeCode
string
Code identifying the type of insurance policy within a specific insurance program (X12 008020 Element 1336)
type_commons_StreetAddressLongZip
object
6 properties 5 required
type_contracts_v2_DateUpdate
type_commons_Date
string
ISO 8601 date; formatted YYYY-MM-DD (i.e. 2012-02-01)
type_payers_v3_PayerUuid
string
type_organization-providers_v2_OrganizationProviderAddress
object
2 properties 2 required
type_organization-service-facilities_v2_OrganizationServiceFacilityId
string
type_contracts_v3_ContractsPage
object
3 properties 1 required
type_organization-providers_v2_EmploymentStatus
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-contracts-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 Contracts 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.