Skip to main content
Lists committed purchases, donations, and winning auction bids for an event, grouped by category, as a PurchasesBundle. Available across all three families:

​
Authorization

The authenticated caller must be the dedicated service user provisioned for your integration, and have access to the event.
Custom Data Export endpoints require a dedicated service user provisioned per customer. Contact support@givergy.com to set up your integration.

​
Path parameters

​
Query parameters

offset and limit apply per category in the response, not across the whole bundle. If you have more than 1000 records in any single category, paginate by re-issuing the request with rising offset until every category returns an empty array. See Polling pattern → Bundle pagination caveat.

​
Response

PurchasesBundle — always the same wrapper shape, with the per-record fields varying by family.
Returns the full variants of every purchase type. Custom Data Export records additionally include:
  • projectSegment — free-form reporting segment
  • processorType — ProcessorType enum (Stripe, PayPal, cash, etc.)
  • paymentStatus — PaymentStatus enum (paid, unpaid, part_paid, etc.)
These three fields are absent from every purchase record on the Salesforce and Blackbaud variants.

​
Example

See the full PurchasesBundle (Custom Data Export) example response.

​
What’s in the response

PurchasesBundle has six top-level keys, each holding an array of records of one type: All purchase records share a common base of fields (id, guestId, amount, created, updated, etc.) plus the type-specific fields listed in the schema. See PurchasesBundle for the full breakdown.

​
Payment-status handling tips

For most reporting use cases on the Custom Data Export variant, treat the following paymentStatus values as “money received”:
  • paid
  • part_paid
  • overpaid
  • split
See the PaymentStatus enum for the full list.