latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Facility Credentialing Outreach Resource

List all outreaches for a facility workflow

Returns a paginated list of every credentialing outreach sent for the given facility credentialing workflow. Use it to render outreach history for a facility workflow, or to obtain an outreachId to pass to the outreach detail endpoint. workflowId must be a facility credentialing workflow ID, not a practitioner credentialing workflow ID - supplying a practitioner workflow ID returns an empty list rather than an error, since an unrecognized workflowId is treated as having no outreaches. Pagination is currently hardcoded to page 0 and size 100 and cannot be changed by the caller; if a workflow has more than 100 outreaches, only the first 100 are returned and the rest are silently omitted. The response envelope (PractitionerOutreachListResponse) is reused verbatim from the practitioner outreach endpoints - its field names refer to practitioners for historical reasons, but it carries facility outreach records here.

get/facility-credentialing-outreaches/workflow/{workflowId}

Path parameters

workflowIdstring required

Facility credentialing workflow ID whose outreach history to retrieve. Must be a facility workflow ID, not a practitioner workflow ID.

Headers

tenant-idstring required

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

Response

A paginated envelope of outreach records for this facility workflow: data (the outreach records, each with attemptsCount and workflowStatus), totalCount (total matching records), and the fixed page (always 0) and size (always 100).

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
}