latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Event Email Settings

List all event email settings for an organization

Returns the complete event email settings envelope for the organization, covering every context (practitioner, facility) and mode (credentialing, recredentialing) combination that has been configured. The response wraps three top-level sub-objects (practitioner, facility, global); any sub-object whose settings have never been saved is returned as null rather than a 404. Use this endpoint to retrieve a full snapshot before editing individual settings, or to detect which context/mode combinations still need configuration. For a single context+mode pair, use GET /{context}/{mode} instead. The global sub-object is deprecated and always null — no write path has ever existed for it; read practitioner and facility instead. Requires TENANT_SETTINGS_EVENT_EMAIL_READ permission.

get/organizations/{organizationId}/event-email-settings

Path parameters

organizationIdstring required

Organization identifier that scopes this request to a specific organization's event email settings. Path segment; opaque string, no enforced format.

Headers

tenant-idstring required

Tenant identifier of the requesting caller. Required on every request; opaque string, no enforced format.

Response

The organization's event email settings envelope (practitioner/facility/global), with unconfigured sub-objects returned as null.