JOjoincandidhealth

Search skmtc

v1

Create

Changed on Sep 19, 2026

Creates a new organization external provider. BadRequestError is returned when the NPI is already in use.

post/organization-external-providers/v1

Request

Base URL
https://pre-api.joincandidhealth.com
URL
https://pre-api.joincandidhealth.com/organization-external-providers/v1
Auth
HTTP bearer

Request body

typesPreEncounterOrganizationExternalProvidersV1OrganizationExternalProviderType[] required

npistring

tax_idstring

taxonomy_codestring

phone_numberstring

other_phone_numbersstring[]

fax_numberstring

other_fax_numbersstring[]

emailsstring[]

license_type'MD' | 'NP' | 'PA' | 'LMFT' | 'LCPC' | 'LCSW' | 'PMHNP' | 'FNP' | 'LPCC' | 'DO' | 'RD' | 'SLP' | 'APRN' | 'LPC' | 'PHD' | 'PSYD' | 'LMSW' | 'LMHC' | 'OTHER_MASTERS' | 'BCBA' | 'UNKNOWN' | 'RPH' | 'PHT' | 'LAC' | 'LMT' | 'DC' | 'ND' | 'MA' | 'PT' | 'IBCLC' | 'RN' | 'DPT' | 'LCMHC' | 'CNM' | 'RNFA' | 'ACSW' | 'APC' | 'BCABA' | 'BHA' | 'OD' | 'DPM' | 'DA' | 'DDS' | 'DEH' | 'DMD' | 'PTA' | 'LCADC' | 'LCAT' | 'LCMHCS' | 'LCMHCA' | 'LCSWA' | 'LICSW' | 'LISW' | 'LMFTS' | 'LMFTA' | 'LPCI' | 'LSCSW' | 'MHCA' | 'MHT' | 'RBT' | 'RCSWI' | 'RHMCI' | 'LPN' | 'OTD' | 'OMS' | 'MFTA' | 'APCC' | 'DNP' | 'AGNPBC' | 'ANP' | 'FNPPP' | 'LCSWR' | 'ALC' | 'RMFTI' | 'LAMFT' | 'LPCA' | 'LSWI' | 'CSW' | 'CPC' | 'LGMFT' | 'LLPC' | 'PLPC' | 'PLMFT' | 'LMHCA' | 'CIT' | 'CT' | 'MFT' | 'LSW' | 'PLMHP' | 'PCMSW' | 'LMHP' | 'OTR/L' | 'RPA' | 'COTA' | 'CRNP' | 'SLP-CF' | 'NP-C' | 'PA-C' | 'AMFT' | 'CDN' | 'CGC' | 'CNS' | 'MDPHD' | 'AuD' | 'ATC' | 'LAT' | 'OTA' | 'LSSP' | 'SLPA'

Response

Response with status 200

organization_idstring required

The unique identifier for an Organization in the database

deactivatedboolean required

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

versioninteger required

The version of the object. Any update to any property of an object object will create a new version.

updated_atstring date-time required

updating_user_idstring required

The unique identifier for a User in the database

typesPreEncounterOrganizationExternalProvidersV1OrganizationExternalProviderType[] required

npistring

tax_idstring

taxonomy_codestring

phone_numberstring

other_phone_numbersstring[]

fax_numberstring

other_fax_numbersstring[]

emailsstring[]

license_type'MD' | 'NP' | 'PA' | 'LMFT' | 'LCPC' | 'LCSW' | 'PMHNP' | 'FNP' | 'LPCC' | 'DO' | 'RD' | 'SLP' | 'APRN' | 'LPC' | 'PHD' | 'PSYD' | 'LMSW' | 'LMHC' | 'OTHER_MASTERS' | 'BCBA' | 'UNKNOWN' | 'RPH' | 'PHT' | 'LAC' | 'LMT' | 'DC' | 'ND' | 'MA' | 'PT' | 'IBCLC' | 'RN' | 'DPT' | 'LCMHC' | 'CNM' | 'RNFA' | 'ACSW' | 'APC' | 'BCABA' | 'BHA' | 'OD' | 'DPM' | 'DA' | 'DDS' | 'DEH' | 'DMD' | 'PTA' | 'LCADC' | 'LCAT' | 'LCMHCS' | 'LCMHCA' | 'LCSWA' | 'LICSW' | 'LISW' | 'LMFTS' | 'LMFTA' | 'LPCI' | 'LSCSW' | 'MHCA' | 'MHT' | 'RBT' | 'RCSWI' | 'RHMCI' | 'LPN' | 'OTD' | 'OMS' | 'MFTA' | 'APCC' | 'DNP' | 'AGNPBC' | 'ANP' | 'FNPPP' | 'LCSWR' | 'ALC' | 'RMFTI' | 'LAMFT' | 'LPCA' | 'LSWI' | 'CSW' | 'CPC' | 'LGMFT' | 'LLPC' | 'PLPC' | 'PLMFT' | 'LMHCA' | 'CIT' | 'CT' | 'MFT' | 'LSW' | 'PLMHP' | 'PCMSW' | 'LMHP' | 'OTR/L' | 'RPA' | 'COTA' | 'CRNP' | 'SLP-CF' | 'NP-C' | 'PA-C' | 'AMFT' | 'CDN' | 'CGC' | 'CNS' | 'MDPHD' | 'AuD' | 'ATC' | 'LAT' | 'OTA' | 'LSSP' | 'SLPA'

idstring uuid required

The unique identifier for an OrganizationExternalProvider in the database

Changes

Sep 19, 202672fc5ca65ba5 Revision changes
- info
  added the new optional request property //
- info
  added the optional property // to the response with the status
Sep 17, 202624b2d80d577a Revision changes
- breaking
  added the new required request property
- breaking
  added the new required request property
- breaking
  the request's body type changed from no type to object
- breaking
  the response's body type changed from no type to object for status
- breaking
  the response's property type changed from no type to object for status
- warning
  deleted the header request parameter Authorization
- info
  the endpoint scheme security OAuthScheme was added to the API
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the optional property to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history (3 revisions)