Candid Health subpackage_encounter-providers.subpackage_encounter-providers/v2 API
The subpackage_encounter-providers.subpackage_encounter-providers/v2 API from Candid Health — 9 operation(s) for subpackage_encounter-providers.subpackage_encounter-providers/v2.
Candid Health subpackage_encounter-providers.subpackage_encounter-providers/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_encounter-providers.subpackage_encounter-providers/v2. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
12 operations
across 9 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.
12 operations9 paths5 schemas4 DELETE4 PATCH4 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_encounter-providers.subpackage_encounter-providers/v2 API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (OAuthScheme).
OAuthScheme — OAuth 2.0 authentication
Paths & Operations 12
Across 9 paths, the API surfaces 12 operations — 4 DELETE, 4 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are type_commons:RequestValidationError (2 properties), type_commons:EntityConflictErrorMessage (1 property), type_commons:EntityNotFoundErrorMessage (1 property). Each schema is shown below with its type and property counts.
type_commons:EntityNotFoundErrorMessage
object
1 property1 required
type_commons:EntityConflictErrorMessage
object
1 property1 required
type_commons:RequestValidationError
object
2 properties1 required
type_commons:EncounterId
string
type_commons:ServiceLineId
string
Specification
The full machine-readable OpenAPI contract behind this narrative.