Skip to main content
Reference for every record type returned by the Events & Auctions API. Where the Custom Data Export and connector variants differ, the Custom Data Export variant is the superset — connector variants omit some fields (see Payload customization examples for the full comparison). Quick links:

Event (Custom Data Export variant)

Returned by GET /<your-namespace>/v1/events.
The Salesforce/Blackbaud Event variant (not returned by any documented endpoint today, but useful background) would omit projectType and externalId.

ItemsBundle

prizeDraws holds standard Raffle records; gliRaffles is a separate list because GLI-regulated raffles have distinct compliance handling. The wrapper shape is identical across all three families; the difference is in the per-record fields (see Payload customization examples).

BuyNowItem

The Salesforce/Blackbaud BuyNowItem variants include only the first 10 fields (down to updated).

AuctionItem

Pledge

Identical across all three families.

Raffle

Connector variants omit revenueStreamType only.

GliRaffle

All fields from Raffle, plus externalId (string | null, Custom Data Export only). GLI-regulated raffles (Gaming Laboratories International) are reported separately for compliance. Connector variants omit revenueStreamType and externalId.

Ticket

BidIncrement

A single tier of a bid-increment ladder.
Some earlier Givergy reference material used from / increment for these field names. The actual JSON field names are threshold and amount. Trust this document over older examples.

Example ItemsBundle (Custom Data Export) response


PurchasesBundle

All purchase records share a common set of fields. Each subtype adds a small number of type-specific fields.

Common purchase fields

The following three fields are present only on the Custom Data Export variants. They are absent from every purchase record returned by the Salesforce and Blackbaud connector endpoints.

Type-specific fields

BuyNowPurchase

Common purchase fields plus:

AuctionBid

Common purchase fields plus: No count field — a winning bid is always 1.

RafflePurchase

Common purchase fields plus:

GliRafflePurchase

Same fields as RafflePurchase, returned under the gliRafflePurchases key. GLI raffles are reported separately for compliance.

TicketPurchase

Common purchase fields plus:

Donation

Common purchase fields plus:

Example PurchasesBundle (Custom Data Export) response

A Salesforce or Blackbaud /purchases response would be the same shape, but every record would have projectSegment, processorType, and paymentStatus removed.

Guest (Custom Data Export variant)

Returned by the Custom Data Export /guests endpoint.

Guest connector variants (Salesforce and Blackbaud)

SalesforceGuest (returned by /salesforce/v1/.../guests) and BlackbaudGuest (returned by /blackbaud/v1/.../guests) are identical to each other and contain every field from the Custom Data Export Guest except externalId, smsOptIn, and companyName. If you need any of those three fields, you must use the Custom Data Export /guests endpoint.

AddressDetail

Note the snake_case spelling: the field is recipient_name, not recipientName. This is the only snake_case field across these schemas.

Enums

All enum values are serialized in lowercase in JSON. See Conventions → Enum casing.

Status enum

Returned for Event.status and Guest.consentStatus. Values: error, archived, active, inactive, not_archived, obfuscated, pending In practice list endpoints only ever return records with status: "active" because of the implicit active-only filter.

PaymentStatus enum

Returned on Custom Data Export purchase records only. For most reporting use cases, treat paid, part_paid, overpaid, and split as “money received.”

ProcessorType enum

Returned on Custom Data Export purchase records only. none, paypal, paypal_here, cheque_client, cheque_ibid, cash_client, cash_ibid, bank_transfer_client, bank_transfer_ibid, braintree, braintree_amex, braintree_vt, braintree_vt_amex, stripe, daf_pay, stripe_amex, stripe_vt, stripe_vt_amex, pdq, pdq_amex, eftpos, amex, zero_amount_charge, free Conventions:
  • The _vt suffix indicates a virtual terminal (typed-in card).
  • _client variants indicate funds collected directly by the client.
  • _ibid variants indicate funds collected by Givergy on the client’s behalf.

giftAidStatus (YesNoAnswer)

Donation.giftAidStatus is a tri-state string answering “has the guest agreed to Gift Aid this donation?”
Earlier Givergy reference material listed values like CLAIMED, PENDING, NOT_REQUESTED. Those are incorrect — the wire values are the three above.
Gift Aid is a UK-only HMRC mechanism, so this field is most meaningful for UK events.