Skip to main content
GET
Search public recipients before adding an entity

Path Parameters

client_id
integer
required

Client id that owns the program and recipient records.

program_id
integer
required

Program id whose HysForm title fields are used to build result names.

session_id
string
required

Optional Redis frontend session id. A new session is created when this one is missing or expired.

Query Parameters

Search term matched against entity JSON fields. Numeric values also match an exact entity id.

limit
integer

Maximum result count. The controller clamps the value between 1 and 25 and defaults to 10.

Required range: 1 <= x <= 25
search_all
string

When set to 1, true, TRUE, yes, or on, archived recipients are included in the search; otherwise only non-deleted records are returned.

Response

Search results for public add-entity duplicate detection.

status
string
Example:

"success"

data
object