Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
CredentialingWorkflow

Get credentialing workflow by ID

Retrieves a single credentialing workflow by its ID

get/credentialing-workflows/{id}

Path parameters

idstring required

ID of the credentialing workflow to retrieve

Query parameters

skipEnrichmentboolean

When true, skips DAL enrichment and verifiedBy user lookups

Headers

X-PII-Viewstring

Include PII in response; requires practitioner read:pii permission

tenant-idstring required

Tenant ID

Response

Successfully retrieved the credentialing workflow

idstring

Unique identifier for the credentialing workflow

tenantIdstring

ID of the tenant

tenantPractitionerIdstring

ID of the tenant practitioner

certifyPractitionerIdstring

Certify practitioner ID

createdBystring

ID of the user who created the credentialing workflow

updatedBystring

ID of the user who updated the credentialing workflow

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "id": "1234",
  "tenantId": "tenant_123456",
  "tenantPractitionerId": "tp_123456",
  "certifyPractitionerId": "cp_123456",
  "data": {
    "credentialingStatus": "IN_PROGRESS",
    "credentialingDecisionDate": "2024-06-15",
    "nextCredentialingDate": "2025-06-15",
    "psvReadyDate": "2024-05-01T14:20:00Z",
    "psvCompletedDate": "2024-06-01T16:45:00Z",
    "credentialingStatusLastUpdatedDate": "2024-01-15T10:30:00Z"
  },
  "createdBy": "user_123456",
  "updatedBy": "user_123456",
  "createdAt": "2022-03-10T16:15:50Z",
  "updatedAt": "2022-03-10T16:15:50Z"
}