Skip to main content
GET
Search commitments 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

donor_id
integer | null

Donor who owns the gift or commitment. Validation: nullable|integer.

Example:

12345

designation
integer | null

Recipient/designation identifier for the donation. Validation: nullable|integer.

Example:

4711

status
enum<string> | null

Requested active or archived lifecycle state. Validation: nullable|string|in:active,archived.

Available options:
active,
archived,
null
Example:

"active"

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