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_service-lines.subpackage_service-lines/v2 API

The subpackage_service-lines.subpackage_service-lines/v2 API from Candid Health — 4 operation(s) for subpackage_service-lines.subpackage_service-lines/v2.

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

This API exposes 5 operations across 4 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.

5 operations 4 paths 5 schemas 1 DELETE2 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_service-lines.subpackage_service-lines/v2 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 5

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

subpackage_service-lines.subpackage_service-lines/v2 5
POST
/api/service-lines/v2
Create Service Line
create 1 param body → 200409422
POST
/api/service-lines/v2/universal
Create Professional or Institutional Service Line
create-universal 1 param body → 200409422
PATCH
/api/service-lines/v2/{service_line_id}/universal
Update service line for encounter that may be institutional or professional.
update-universal 2 params body → 200403404422
PATCH
/api/service-lines/v2/{service_line_id}
Update Service Line
update 2 params body → 200403404422
DELETE
/api/service-lines/v2/{service_line_id}
Delete Service Line
delete 2 params → 200403404409

Schemas 5

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:UnauthorizedErrorMessage (1 property), type_commons:EntityNotFoundErrorMessage (1 property), type_commons:EntityConflictErrorMessage (1 property). Each schema is shown below with its type and property counts.

type_commons:EntityConflictErrorMessage
object
1 property 1 required
type_commons:EntityNotFoundErrorMessage
object
1 property 1 required
type_commons:RequestValidationError
object
2 properties 1 required
type_commons:UnauthorizedErrorMessage
object
1 property
type_commons:ServiceLineId
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-subpackage-service-lines-subpackage-service-lines-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