Sign in
Facility Credentialing Outreach Resource

Get full detail for a facility outreach

Returns the complete detail record for one facility outreach: the full email thread (each email with its replies and attachments) and a chronological status-transition timeline. Call it after obtaining an outreachId from the outreach list endpoint (GET /facility-credentialing-outreaches/workflow/{workflowId}) or from the outreachId in a successful POST /facility-credentialing-outreaches response. Read-only; it has no side effects. outreachId must identify an outreach record visible to the tenant supplied in the tenant-id header.

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

Path parameters

outreachIdstring required

Outreach record ID, obtained from the outreach list endpoint or from a POST /facility-credentialing-outreaches response.

Headers

tenant-idstring required

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

Response

The outreach detail record: emails (each with direction, deliveryStatus, replies, and attachments - attachments[].id is usable with the attachment download endpoint), and timeline (chronological entries, each with a type of "outreach" or "email" and a status label).

idstring

Outreach record ID

tenantIdstring

Tenant that owns this outreach record

workflowIdstring

Credentialing workflow (practitioner or facility) this outreach was sent for

outreachType'PRACTITIONER_CREDENTIALING' | 'FACILITY_CREDENTIALING' | 'PRACTITIONER_MONITORING'

Outreach category this record was created for

activeboolean

Whether this outreach is still open/awaiting a response

attemptsCountinteger

Number of outreach emails sent for this record

lastAttemptedAtstring date-time
workflowStatusstring

Status of the referenced credentialing workflow at the time of this response

createdBystring

User ID that created this outreach record

createdByNamestring

Display name of the user that created this outreach record

createdAtstring date-time
updatedAtstring date-time

Example response

{
  "outreachType": "FACILITY_CREDENTIALING",
  "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": [
    {
      "direction": "OUTBOUND",
      "deliveryStatus": "delivered",
      "createdAt": "2022-03-10T16:15:50Z",
      "updatedAt": "2022-03-10T16:15:50Z",
      "replies": [
        {
          "direction": "INBOUND",
          "createdAt": "2022-03-10T16:15:50Z",
          "updatedAt": "2022-03-10T16:15:50Z",
          "attachments": [
            {
              "type": "application/pdf"
            }
          ]
        }
      ],
      "attachments": [
        {
          "type": "application/pdf"
        }
      ]
    }
  ],
  "timeline": [
    {
      "date": "2022-03-10T16:15:50Z",
      "type": "outreach",
      "status": "Email Delivered"
    }
  ]
}

Changes

Changed in 1 of the 2 revisions of this API.128

  • 563848e0ecc0128See the full diff
    • ●

      added the new FACILITY_CREDENTIALING enum value to the outreachType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new INBOUND enum value to the emails/items/direction response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new INBOUND enum value to the emails/items/replies/items/direction response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new OUTBOUND enum value to the emails/items/direction response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new OUTBOUND enum value to the emails/items/replies/items/direction response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PRACTITIONER_CREDENTIALING enum value to the outreachType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PRACTITIONER_MONITORING enum value to the outreachType response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new deferred enum value to the emails/items/deliveryStatus response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new delivered enum value to the emails/items/deliveryStatus response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new email enum value to the timeline/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new outreach enum value to the timeline/items/type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new processed enum value to the emails/items/deliveryStatus response property for the response status 200

      response-property-enum-value-added

    • ○

      added the media type application/json for the response with the status 401

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 403

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 404

      response-media-type-added

    • ○

      added the media type application/json for the response with the status 500

      response-media-type-added

    • ○

      added the optional property emails/items/attachments/items/reasonId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property emails/items/replies/items/attachments/items/reasonId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property emails/items/replies/items/submitterEmail to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property emails/items/submitterEmail to the response with the 200 status

      response-optional-property-added

    This revision also has 44 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog