Skip to main content
GET
Search commitment preview options

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

emailset_id
integer<int64>
required

Email set ID whose linked programs determine which sponsorships can be searched for preview data.

trigger
string
required

Template trigger being previewed, such as pay_receipt or recip_email; the controller uses it to keep the route aligned with the template editor context.

Query Parameters

search
string | null

Optional search term. Matches donor names, recipient title fields, commitment IDs, and donor-entity IDs; validation rule: nullable|string|max:255.

Maximum string length: 255
limit
integer | null

Maximum number of options to return. Validation rule: nullable|integer|min:1|max:50; defaults to 20 in this search endpoint.

Required range: 1 <= x <= 50

Response

Matching sponsorship preview options.

data
object[]

Option rows formatted for the template preview selector.