Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Credentialing Outreach Resource

List outreaches for a practitioner credentialing workflow

Returns all outreach records associated with a practitioner credentialing workflow, ordered by creation date descending. Use this to display the outreach history for a single practitioner workflow; for facility workflows, use the facility-specific outreach endpoint instead. workflowId must be a practitioner credentialing workflow ID obtainable from the workflow management APIs - an unrecognized workflowId returns an empty list rather than a 404. The response is a PractitionerOutreachListResponse envelope; page and size are currently fixed at 0 and 100 respectively (pagination is not yet supported), so a workflow with more than 100 outreaches will not return the remainder.

get/credentialing-outreaches/workflow/{workflowId}

Path parameters

workflowIdstring required

Practitioner credentialing workflow ID whose outreach history to retrieve.

Headers

tenant-idstring required

Tenant ID used to scope the query to the caller's organization.

Response

A PractitionerOutreachListResponse envelope containing the outreach records for this workflow (each with attemptsCount, workflowStatus, and enriched reasons), totalCount, and the fixed page/size values.

totalCountinteger

Total number of outreach records matching this workflow

pageinteger

Current page index. Always 0 - pagination is not yet supported

sizeinteger

Page size. Always 100 - a hardcoded ceiling; records beyond this are not returned

Example response

{
  "data": [
    {
      "outreachType": "FACILITY_CREDENTIALING",
      "reasons": [
        {
          "id": "reason-123e4567-e89b-12d3-a456-426614174000",
          "label": "Malpractice Insurance Missing"
        }
      ],
      "lastAttemptedAt": "2022-03-10T16:15:50Z",
      "createdAt": "2022-03-10T16:15:50Z",
      "updatedAt": "2022-03-10T16:15:50Z"
    }
  ],
  "size": 100
}