Sign in

v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Facility Credentialing Outreach Resource

Get a single facility outreach with emails and replies

Returns the details of a facility outreach including all its emails, their replies, and a timeline

get/facility-credentialing-outreaches/{outreachId}/details

Path parameters

outreachIdstring required

Outreach ID

Headers

tenant-idstring required

Tenant ID

Response

Outreach detail retrieved successfully

idstring
tenantIdstring
workflowIdstring
outreachTypestring
activeboolean
attemptsCountinteger
lastAttemptedAtstring date-time
workflowStatusstring
createdBystring
createdByNamestring
createdAtstring date-time
updatedAtstring date-time

Example response

{
  "reasons": [
    {
      "id": "reason-123",
      "label": "Malpractice Insurance Missing"
    }
  ],
  "lastAttemptedAt": "2022-03-10T16:15:50Z",
  "createdAt": "2022-03-10T16:15:50Z",
  "updatedAt": "2022-03-10T16:15:50Z",
  "emails": [
    {
      "createdAt": "2022-03-10T16:15:50Z",
      "updatedAt": "2022-03-10T16:15:50Z",
      "replies": [
        {
          "createdAt": "2022-03-10T16:15:50Z",
          "updatedAt": "2022-03-10T16:15:50Z"
        }
      ]
    }
  ],
  "timeline": [
    {
      "date": "2022-03-10T16:15:50Z"
    }
  ]
}