Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Credentialing Outreach Resource

Fetch full outreach detail with emails, replies, and timeline

Returns the complete detail view of a single outreach record, including the full email thread, replies, attachments, and a chronological timeline. Use this when you need to render the outreach history in full - email bodies, recipient statuses, reply chains, or the activity timeline; for a lightweight status check without email content, use GET /credentialing-outreaches/{id} instead. The id is the outreach record ID returned in the 201 body of POST /credentialing-outreaches, or from GET /credentialing-outreaches/workflow/{workflowId}. This endpoint is read-only and has no side effects.

get/credentialing-outreaches/{id}/details

Path parameters

idstring required

Outreach record ID, returned from POST /credentialing-outreaches or GET /credentialing-outreaches/workflow/{workflowId}.

Headers

tenant-idstring required

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

Response

An OutreachDetailResponse containing the outreach's emails (each with direction, deliveryStatus, replies, and attachments - each attachment has an id usable with GET /credentialing-outreaches/attachments/{attachmentId}/download) and a chronological timeline (each entry has a type of "outreach" or "email", and a status).

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"
    }
  ]
}