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_organization-service-facilities.subpackage_organization-service-facilities/v2 API

The subpackage_organization-service-facilities.subpackage_organization-service-facilities/v2 API from Candid Health — 3 operation(s) for subpackage_organization-service-facilities.subpackage_organization-service-facilities/v2.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

6 operations 3 paths 6 schemas 1 DELETE3 GET1 PATCH1 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_organization-service-facilities.subpackage_organization-service-facilities/v2 API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (OAuthScheme).

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 6

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

subpackage_organization-service-facilities.subpackage_organization-service-facilities/v2 6
GET
/api/organization-service-facilities/v2/{organization_service_facility_id}
Get organization service facility
get 2 params → 200404
PATCH
/api/organization-service-facilities/v2/{organization_service_facility_id}
Update organization service facility
update 2 params body → 200404409422
DELETE
/api/organization-service-facilities/v2/{organization_service_facility_id}
Delete organization service facility
delete 2 params → 200404
GET
/api/organization-service-facilities/v2
Get all organization service facilities
get-multi 8 params → 200
POST
/api/organization-service-facilities/v2
Create organization service facility
create 1 param body → 200409422
GET
/api/organization-service-facilities/v2/external-id/{external_id}
Get organization service facility by externalid
get-by-external-id 2 params → 200404

Schemas 6

The contract defines 6 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:OrganizationId
string
type_commons:EntityNotFoundErrorMessage
object
1 property 1 required
type_commons:EntityConflictErrorMessage
object
1 property 1 required
type_commons:PageToken
string
type_commons:RequestValidationError
object
2 properties 1 required
type_commons:FacilityTypeCode
string
Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 02 for telemedicine, 11 for in-person. Full list here: https://www.…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-subpackage-organization-service-facilities-subpackage-organization-service-facilities-v2-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_contracts.subpackage_contracts/v3 API
AE Profile APIs.io
#subpackage_organization-service-facilities.subpackage_organization-service-facilities/v2
← Back to C APIs
API Details
ID
candid-health:candid-health-subpackage-organization-service-facilities-subpackage-organization-service-facilities-v2-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