Skip to main content

Documentation Index

Fetch the complete documentation index at: https://momogood.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Lists committed purchases, donations, and winning auction bids for an event, grouped by category, as a PurchasesBundle. Available across all three families:
FamilyPathPayload
Custom Data ExportGET /<your-namespace>/v1/events/{eventId}/purchasesIncludes payment status, processor type, and project segment.
SalesforceGET /salesforce/v1/events/{eventId}/purchasesPayment metadata stripped. Tailored for Salesforce ingestion.
BlackbaudGET /blackbaud/v1/events/{eventId}/purchasesPayment metadata stripped. Tailored for Blackbaud ingestion.

​
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

NameTypeNotes
eventIdUUIDEMS event id (returned by List events).

​
Query parameters

NameTypeDefaultNotes
sincelong1606062358updated >= since.
offsetint0Applied per category independently.
limitint1000Page size per category. Maximum 1000.
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

curl --cookie session.cookie \
  '{EMS_BASE_URL}/<your-namespace>/v1/events/8f3c2a1d-9b4e-4c7a-a1d2-6e5f4c3b2a10/purchases?since=1714000000'
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:
Wrapper keyRecord typeWhat it represents
buyNowPurchasesBuyNowPurchaseCompleted purchases of buy-now items.
winningBidsAuctionBidWinning bids on auction lots. (count is always 1; no count field.)
donationsDonationPledged donations, including Gift Aid status.
rafflePurchasesRafflePurchaseRaffle ticket purchases, including winningCount.
gliRafflePurchasesGliRafflePurchaseGLI-regulated raffle ticket purchases.
ticketPurchasesTicketPurchaseEvent-entry ticket purchases.
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.