v1

latestOpenAPI 3.0.02026-08-0679302767.4 KB

credentialing-workflows

Populate template fields for credentialing workflow

Retrieves and populates template fields for the specified credentialing workflow. Useful for generating documents, emails, or other communications that require workflow-specific data to be inserted into templates.

get/credentialing-workflows/{id}/populate-template-fields

Path parameters

idstring required

The unique identifier of the credentialing workflow for which to populate template fields.

Query parameters

reasonsstring required

A comma-separated list of reasons to be included in the template fields (e.g., "reason1,reason2"). These reasons should already be present in the organization settings under "outreach" to be used here.

Headers

organization-idstring

Response

Successfully populated template fields

{"stackTrail":"paths:/credentialing-workflows/{id}/populate-template-fields:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"workflowId":"abc123","providerName":"Dr. Jane Doe","organizationName":"HealthCare Org","reasons":["Missing License","Incomplete Application"],"otherField1":"value1","otherField2":"value2"}}

Example response

{
  "workflowId": "abc123",
  "providerName": "Dr. Jane Doe",
  "organizationName": "HealthCare Org",
  "reasons": [
    "Missing License",
    "Incomplete Application"
  ],
  "otherField1": "value1",
  "otherField2": "value2"
}