Skip to content

CertifyOS API

Download OpenAPI description
Overview
Languages
Servers
Mock server
https://docs.certifyos.com/_mock/reference/application/api/
Production
https://ng-api-production.certifyos.com/
Staging (Test Data)
https://ng-api-stg.certifyos.com/

auth-tokens

Operations

credentialing-workflows

Operations

v2/credentialing-workflows

Operations

providers

Operations

v2/provider

Operations

Get list of provider specialties

Request

Retrieves a list of specialties for the specified provider.

Security
BearerAuth
Path
providerIdstringrequired
Query
offsetnumber>= 0

The starting index for pagination, specifying how many records to skip.

Default 0
limitnumber

The maximum number of records to retrieve in a single request.

Default 10
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/specialties?offset=0&limit=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

List of specialties

Bodyapplication/json
any
Response
application/json
[ { "id": "string", "specialty_nucc_taxonomy_code": "string", "name": "string", "is_primary": true, "sub_specialties": [ … ] } ]

Create provider specialties

Request

Create a specialty with optional sub-specialties

Security
BearerAuth
Path
providerIdstringrequired
Headers
organization-idstring
Bodyapplication/jsonrequired
specialty_nucc_taxonomy_codestringrequired

Nucc taxonomy code tied to this specialty

namestringrequired

Name of specialty tied to this taxonomy code

is_primarybooleanrequired

Whether this specialty is the provider’s primary speciality; they can only have 1 primary specialty

sub_specialtiesArray of objects(SubSpecialtiesV2Dto)required

Provider’s subspecialties that are tied to this specialty [array] (if there are no subspecialties, include the field, but just put empty [])

Default []
specialty_nucc_taxonomy_codestringrequired

Nucc taxonomy code tied to this subspecialty

namestringrequired

Name of subspecialty tied to this taxonomy code

curl -i -X POST \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/specialties' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "specialty_nucc_taxonomy_code": "string",
    "name": "string",
    "is_primary": true,
    "sub_specialties": []
  }'

Responses

Specialty created successfully.

Update provider specialty

Request

Update specialty details with optional sub-specialties

Security
BearerAuth
Path
providerIdstringrequired
specialtyIdstringrequired
Headers
organization-idstring
Bodyapplication/jsonrequired
specialty_nucc_taxonomy_codestringrequired

Nucc taxonomy code tied to this specialty

namestringrequired

Name of specialty tied to this taxonomy code

is_primarybooleanrequired

Whether this specialty is the provider’s primary speciality; they can only have 1 primary specialty

sub_specialtiesArray of objects(SubSpecialtiesV2Dto)required

Provider’s subspecialties that are tied to this specialty [array] (if there are no subspecialties, include the field, but just put empty [])

Default []
specialty_nucc_taxonomy_codestringrequired

Nucc taxonomy code tied to this subspecialty

namestringrequired

Name of subspecialty tied to this taxonomy code

curl -i -X PATCH \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/specialties/{specialtyId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '{
    "specialty_nucc_taxonomy_code": "string",
    "name": "string",
    "is_primary": true,
    "sub_specialties": []
  }'

Responses

Updated.

v2/providers

Operations

v2/flags

Operations

v2/provider-with-groups

Operations

flags

Operations

v2/groups

Operations

Webhooks

Operations

forms

Operations

v2/facility-credentialing-workflows

Operations

v2/facilities

Operations