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 Organization External Providers API

The Organization External Providers API from Candid Health — 4 operation(s) for organization external providers.

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

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

6 operations 4 paths 18 schemas 1 DELETE3 GET1 POST1 PUT

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

  • OAuthScheme — OAuth 2.0 authentication

Paths & Operations 6

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

Organization External Providers 6
GET
/organization-external-providers/v1/{id}
Get
get 2 params → 200404
GET
/organization-external-providers/v1
Get Multi
getMulti 9 params → 200
POST
/organization-external-providers/v1
Create
create 1 param body → 200400
PUT
/organization-external-providers/v1/{id}/{version}
Update
update 3 params body → 200400404409
DELETE
/organization-external-providers/v1/{id}/{version}
Deactivate
deactivate 3 params → 200404409
GET
/organization-external-providers/v1/updates/scan
Scan
scan 3 params → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProvider (18 properties), type_pre-encounter_organizationExternalProviders_v1_MutableOrganizationExternalProvider (12 properties), type_pre-encounter_common_Address (8 properties), type_pre-encounter_common_HumanName (5 properties). Each schema is shown below with its type and property counts.

type_pre-encounter_common_AddressUse
string
type_pre-encounter_common_Period
object
2 properties
type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderId
string
The unique identifier for an OrganizationExternalProvider in the database
type_pre-encounter_common_NameUse
string
type_pre-encounter_common_Address
object
8 properties 6 required
type_pre-encounter_common_ErrorBase4xx
object
2 properties 1 required
type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderSortField
string
The field to order by. Valid values are keys on the provider object (e.g., name.family, npi, updatedAt, createdAt) or a special ordering "similarname: " (Ex: s…
type_pre-encounter_organizationExternalProviders_v1_MutableOrganizationExternalProvider
object
An object representing an organization-level external provider.
12 properties 2 required
type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderPage
object
4 properties 2 required
type_pre-encounter_common_UserId
string
The unique identifier for a User in the database
type_pre-encounter_common_SortDirection
string
type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProviderType
string
type_pre-encounter_common_OrganizationId
string
The unique identifier for an Organization in the database
type_pre-encounter_organizationExternalProviders_v1_LicenseType
string
type_pre-encounter_common_PageToken
string
A token that can be used to retrieve the next or previous page of results
type_pre-encounter_common_VersionConflictErrorBody
object
3 properties 1 required
type_pre-encounter_common_HumanName
object
5 properties 3 required
type_pre-encounter_organizationExternalProviders_v1_OrganizationExternalProvider
object
An OrganizationExternalProvider object with immutable server-owned properties.
18 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

candid-health-organization-external-providers-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 Organization External Providers 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.