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 subpackage_credentialing.subpackage_credentialing/v2 API

The subpackage_credentialing.subpackage_credentialing/v2 API from Candid Health — 4 operation(s) for subpackage_credentialing.subpackage_credentialing/v2.

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

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

10 operations 4 paths 8 schemas 2 DELETE4 GET2 PATCH2 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_credentialing.subpackage_credentialing/v2 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 10

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

subpackage_credentialing.subpackage_credentialing/v2 10
POST
/api/provider-credentialing-span/v2/facility
Create facility credentialing span
create-facility 1 param body → 200403422
GET
/api/provider-credentialing-span/v2/facility
Get all facility credentialing spans
get-all-facilities 6 params → 200403422
GET
/api/provider-credentialing-span/v2/facility/{facility_credentialing_id}
Get facility credentialing span
get-facility 2 params → 200403404
DELETE
/api/provider-credentialing-span/v2/facility/{facility_credentialing_id}
Delete facility credentialing span
delete-facility 2 params → 200403404
PATCH
/api/provider-credentialing-span/v2/facility/{facility_credentialing_id}
Update facility credentialing span
update-facility 2 params body → 200403404422
POST
/api/provider-credentialing-span/v2
Create provider credentialing span
create 1 param body → 200403422
GET
/api/provider-credentialing-span/v2
Get all provider credentialing spans
get-all 7 params → 200403422
GET
/api/provider-credentialing-span/v2/{provider_credentialing_id}
Get provider credentialing span
get 2 params → 200403404
DELETE
/api/provider-credentialing-span/v2/{provider_credentialing_id}
Delete provider credentialing span
delete 2 params → 200403404
PATCH
/api/provider-credentialing-span/v2/{provider_credentialing_id}
Update provider credentialing span
update 2 params body → 200403404422

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are type_commons:RequestValidationError (2 properties), type_commons:UnprocessableEntityErrorMessage (1 property), type_commons:EntityNotFoundErrorMessage (1 property), type_commons:UnauthorizedErrorMessage (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:Regions
type_commons:ProviderCredentialingSpanId
string
type_commons:UnprocessableEntityErrorMessage
object
1 property
type_commons:RequestValidationError
object
2 properties 1 required
type_commons:UnauthorizedErrorMessage
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-subpackage-credentialing-subpackage-credentialing-v2-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 subpackage_auth.subpackage_auth/default API
Candid Health subpackage_billing-notes.subpackage_billing-notes/v2 API
Candid Health subpackage_charge-capture-bundles.subpackage_charge-capture-bundles/v1 API
Candid Health subpackage_charge-capture.subpackage_charge-capture/v1 API
Candid Health subpackage_contracts.subpackage_contracts/v2 API
Candid Health subpackage_contracts.subpackage_contracts/v3 API