Skip to main content

Retrieve outreach settings for one type and cycle

GET 
/organizations/:organizationId/outreach-settings/:type

Returns the outreach settings saved for a single outreach type and credentialing cycle. Use GET /organizations/{organizationId}/outreach-settings instead when the full set across all types is needed. Supply either credentialingCycle (defaults to INITIAL when omitted) or workflowId - not both; when workflowId is supplied, the cycle is extracted from that workflow and credentialingCycle is ignored. If nothing has been saved yet for the requested type and cycle, this still returns 200 with an empty-shell OutreachSettingsResponse (all fields null except type and credentialingCycle) rather than 404; 404 is reserved for an organization that does not exist, or a workflowId that does not resolve to an existing credentialing workflow. An invalid type value is not validated explicitly here; as currently implemented it results in a generic 500, not a 400 - see the 500 response description. Requires the TENANT_SETTINGS_OUTREACH_READ permission.

Request​

Responses​

The saved OutreachSettingsResponse for this type and cycle (email recipient preferences, template, outreach reasons, smart-outreach settings), or an empty-shell OutreachSettingsResponse with all fields null besides type and credentialingCycle when nothing has been saved yet for this combination.