Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Organization Outreach Settings Resource

List all outreach settings for an organization

Returns every outreach settings record configured for the organization, one entry per outreach type that has been saved, grouped by type. Use this when the full configuration across all three outreach types (PRACTITIONER_CREDENTIALING, FACILITY_CREDENTIALING, PRACTITIONER_MONITORING) is needed in a single call; use GET /organizations/{organizationId}/outreach-settings/{type} instead when only one type is needed. Requires the TENANT_SETTINGS_OUTREACH_READ permission.

get/organizations/{organizationId}/outreach-settings

Path parameters

organizationIdstring required

Organization ID whose outreach settings to list.

Headers

tenant-idstring required

Tenant ID of the requesting user; must be a non-blank string or the request fails with 400.

Response

The organization's configured outreach settings, one OutreachSettingsResponse per outreach type that has been saved (type, credentialing cycle, email recipient preferences, template, outreach reasons, and smart-outreach settings). Returns an empty array - not 404 - when the organization has not saved any outreach settings yet.

type'PRACTITIONER_CREDENTIALING' | 'FACILITY_CREDENTIALING' | 'PRACTITIONER_MONITORING'

The outreach configuration category a settings record applies to. PRACTITIONER_CREDENTIALING covers outreach for individual practitioners going through initial or recredentialing review. FACILITY_CREDENTIALING covers the same for facilities. PRACTITIONER_MONITORING covers ongoing monitoring-triggered outreach for practitioners, outside the credentialing review cycle.

credentialingCycle'INITIAL' | 'RECREDENTIALING'

Credentialing cycle for which these template/reasons apply

providerPortalEnabledboolean nullable

Whether the provider outreach portal is enabled for this organization. Organization-wide (not per type/cycle); null when the organization has never saved the setting, which consumers must treat as disabled.

Example response

[
  {
    "credentialingCycle": "INITIAL",
    "emailRecipientPreferences": {
      "primaryEmail": true,
      "credentialingPrimaryContact": true
    },
    "template": {
      "ccEmails": [
        "cc1@example.com",
        "cc2@example.com"
      ],
      "subject": "Action Required: Update Needed for {{provider_name}} for {{client_name}} Credentialing - Notice #{{number_of_outreach_attempts}}",
      "body": "Hi {{provider_name}}, {{provider_type}} (NPI = {{provider_npi}}),\\n{{client_name}} has partnered with Certify for provider credentialing.",
      "logo": {
        "enabled": true,
        "url": "https://storage.googleapis.com/certifyos-public-assets/images/county-header-nevada.png",
        "width": "100%"
      }
    },
    "outreachReasons": [
      {
        "id": "reason-123e4567-e89b-12d3-a456-426614174000",
        "reason": "Malpractice Insurance Missing",
        "instruction": "Your state license is either missing or has expired.",
        "submitFormText": "Please upload a current copy of your malpractice insurance certificate."
      }
    ],
    "smartOutreach": {
      "businessDaysBetweenAttempts": 5,
      "maxAttemptsPerReason": 5,
      "recredCadenceDays": 2
    }
  }
]