Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

CredentialingWorkflow

Retrieve a single credentialing workflow by ID

Returns the full credentialing workflow record for the given id, including enriched practitioner data and sanction type display mappings. Use this endpoint when you need the complete state of one workflow; use GET /credentialing-workflows for search/list operations. Pass X-PII-View: true to include unmasked PII fields in the response. When skipEnrichment is true, DAL enrichment and verifiedBy user lookups are skipped and those fields will be absent from the response. Returns 404 if no workflow with the given id exists within the caller's tenant scope.

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
applicationCompleteDatestring date-time
applicationCompleteSourcestring

Source that marked the application complete (one of: WORKFLOW_CREATED, NO_SECTION_B_OUTREACH, LATEST_INFORMATION_RECEIVED_EMAIL, LATEST_INFORMATION_RECEIVED_CAQH, NO_VALID_RESPONSE, CANCELLED_BEFORE_PSV)

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",
  "applicationCompleteDate": "2022-03-10T16:15:50Z",
  "applicationCompleteSource": "WORKFLOW_CREATED"
}