v1

latestOpenAPI 3.0.02026-08-0679302767.4 KB
credentialing-workflows

List of credentialing workflows

Returns a paginated list of credentialing workflows for the organization.

get/credentialing-workflows

Query parameters

offsetnumber

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

limitnumber

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

providerNpistring

Filter by provider NPI.

providerFirstNamestring

Filter by provider first name.

providerLastNamestring

Filter by provider last name.

providerTypestring

Filter by provider type.

providerFileTypestring

Filter by provider file type.

providerStatestring

Filter by a single provider state.

Filter by multiple provider states.

Filter by provider assigned states.

namestring

Filter by workflow or provider name.

onStepstring

Filter by current workflow step (e.g. PSV_READY, IN_PROGRESS).

Filter by outreach reasons.

createdAtStartstring date-time

Filter workflows created on or after this date (ISO 8601).

createdAtEndstring date-time

Filter workflows created on or before this date (ISO 8601).

nextCredentialingStartstring date-time

Filter by next credentialing start date (on or after).

nextCredentialingEndstring date-time

Filter by next credentialing end date (on or before).

credentialingCycle'Initial' | 'Recredentialing'

Filter by credentialing cycle.

completedAtStartstring date-time

Filter workflows completed on or after this date.

completedAtEndstring date-time

Filter workflows completed on or before this date.

credentialingStatusUpdatedAtStartstring date-time

Filter by credentialing status updated at (start of range).

credentialingStatusUpdatedAtEndstring date-time

Filter by credentialing status updated at (end of range).

psvCompleteDateStartstring date-time

Filter by PSV complete date (start of range).

Filter by specific workflow IDs.

assignedTostring

Filter by user ID the workflow is assigned to.

includeTerminatedProvidersboolean

Include workflows for terminated providers.

providerExternalIdstring

Filter by provider external ID.

locationType'primaryCare' | 'specialtyCare' | 'behavioralHealth' | 'urgentCare' | 'surgicalServices' | 'rehabilitationServices' | 'laboratoryServices' | 'imagingServices' | 'longTermCare' | 'hospiceOrPalliativeCare' | 'homeHealthServices' | 'others'

Filter by organization entity location type.

Filter by organization entity IDs.

Filter by provider organization entity IDs.

Headers

organization-idstring

Response

Paginated list of credentialing workflows.

countnumber required

Total number of credentialing workflows matching the filter (for pagination).

Example response

{
  "count": 42
}