Skip to main content
GET
Search recipients for Zapier

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Query Parameters

id
integer | null

Existing record identifier in the authenticated organization. Validation: nullable|integer.

Example:

12345

query
string | null

Text used to search matching records. Validation: nullable|string.

Example:

"Jane"

program_id
integer | null

Program containing the recipient or sponsorship. Validation: nullable|integer.

Example:

11

limit
integer | null

Maximum search records to return; default25. Validation: nullable|integer|min:1|max:100.

Required range: 1 <= x <= 100
Example:

25

Response

Matching record projections.

data
object[]
required

Matching records. An ID lookup with no record returns an empty array.

count
integer
required

Number of returned records.

Example:

1