Skip to content
CertifyOS API
/
/
Retrieve groups/ org-enti...

CertifyOS API

Download OpenAPI description
api.json
api.yaml
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

Modify groups associated to a provider

Request

Modifies the groups (org-entities) associated with a provider.

Security
BearerAuth
Path
providerIdstringrequired
Headers
organization-idstring
Bodyapplication/jsonrequiredArray [
group_namestringrequired

Name of the group

group_npistring= 10 charactersrequired

Group National Provider Identifier (NPI)

Example: "2345678901"
group_tinstring= 9 charactersrequired

Group Tax Identification Number (TIN)

Example: "123456789"
location_namestring

Name of group location

external_group_idstring

Client's ID for the group

]
curl -i -X PUT \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/groups' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'organization-id: string' \
  -d '[
    {
      "group_name": "string",
      "group_npi": "2345678901",
      "group_tin": "123456789",
      "location_name": "string",
      "external_group_id": "string"
    }
  ]'

Responses

The record has been successfully updated.

Retrieve groups/ org-entities for a provider.

Request

Fetches all the groups (org-entities) associated with a provider.

Security
BearerAuth
Path
providerIdstringrequired
Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/groups' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Provider Groups.

Bodyapplication/jsonArray [
group_namestringrequired

Name of the group

group_npistring= 10 charactersrequired

Group National Provider Identifier (NPI)

Example: "2345678901"
group_tinstring= 9 charactersrequired

Group Tax Identification Number (TIN)

Example: "123456789"
external_group_idstring

Client's ID for the group

idstringrequired
]
Response
application/json
[
  {
    "group_name": "string",
    "group_npi": "2345678901",
    "group_tin": "123456789",
    "external_group_id": "string",
    "id": "string"
  }
]

Retrieve credentialing workflow timelines for a provider

Request

Returns a list of credentialing workflow timeline records for the specified provider within the organization. Each record contains credentialing status, cycle, dates, and related metadata.

Security
BearerAuth
Path
providerIdstringrequired

The unique identifier of the provider whose credentialing workflow timelines are being retrieved.

Headers
organization-idstring
curl -i -X GET \
  'https://docs.certifyos.com/_mock/reference/application/api/v2/provider/{providerId}/credentialing-workflow-timelines' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'organization-id: string'

Responses

Credentialing workflow timelines

Bodyapplication/jsonArray [
credentialingWorkflowIdstringrequired
credentialingStatusstringrequired
credentialingCyclestringrequired
providerIdstringrequired
organizationIdstringrequired
orgEntityobject(CredentialingWorkflowOrgEntityTypeDto)required
idstringrequired
Default null
namestring
Default null
medicalDirectorIdstringrequired
medicalDirectorNamestringrequired
receivedForCredentialingDatestringrequired
attestationDatestringrequired
initialCredentialingDatestringrequired
lastCredentialedDatestringrequired
psvCompleteDatestringrequired
credentialingDecisionDatestringrequired
nextCredentialingDatestringrequired
updatedAtstringrequired
updatedByNamestringrequired
updatedBystringrequired
createdAtstringrequired
createdBystringrequired
createdByNamestringrequired
decisionEnteredByIdstringrequired
decisionEnteredByNamestringrequired
]
Response
application/json
[
  {
    "credentialingWorkflowId": "string",
    "credentialingStatus": "string",
    "credentialingCycle": "string",
    "providerId": "string",
    "organizationId": "string",
    "orgEntity": { … },
    "medicalDirectorId": "string",
    "medicalDirectorName": "string",
    "receivedForCredentialingDate": "string",
    "attestationDate": "string",
    "initialCredentialingDate": "string",
    "lastCredentialedDate": "string",
    "psvCompleteDate": "string",
    "credentialingDecisionDate": "string",
    "nextCredentialingDate": "string",
    "updatedAt": "string",
    "updatedByName": "string",
    "updatedBy": "string",
    "createdAt": "string",
    "createdBy": "string",
    "createdByName": "string",
    "decisionEnteredById": "string",
    "decisionEnteredByName": "string"
  }
]

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