Find possible existing recipients for check intake
Requires the participation feature, programs_view and access to this organization-owned program. Requires participation_record, participation_submit or participation_configure and access to the check’s site/cohort. Returns up to eight candidate names from this program, including archived matches and already-added markers. Search considers up to sixty matching custom-field rows and ranks exact names first. Scoped roles can discover unplaced recipients; current placements outside their scope are excluded. This search does not require the check to remain draft; archived matches cannot be attached through existing-recipients.
Authorizations
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Program whose participation setup, placements and checks are being accessed.
x >= 1Participation check ID within this program.
x >= 1Query Parameters
Recipient name or profile text used to avoid duplicate intake.
2 - 255Response
Find possible existing recipients for check intake response.
8