Skip to main content
Lists guests registered for an event, joined with their consent record. Available across all three families:
FamilyPathPayload
Custom Data ExportGET /<your-namespace>/v1/events/{eventId}/guestsFull record including externalId, smsOptIn, and companyName.
SalesforceGET /salesforce/v1/events/{eventId}/guestsLean record. Omits externalId, smsOptIn, and companyName.
BlackbaudGET /blackbaud/v1/events/{eventId}/guestsSame as Salesforce variant.

​
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
qstring""Full-text search across name, email, etc.
sincelong1606062358updated >= since.
offsetint0Pagination offset.
limitint1000Page size. Maximum 1000.

​
Response

Guest[] — Custom Data Export variant. Includes externalId, smsOptIn, and companyName fields not present on the connector variants.

​
Example

curl --cookie session.cookie \
  '{EMS_BASE_URL}/<your-namespace>/v1/events/8f3c2a1d-9b4e-4c7a-a1d2-6e5f4c3b2a10/guests?since=1714000000&limit=500'

[
  {
    "id": "f0000001-0000-4000-8000-000000000001",
    "eventId": "8f3c2a1d-9b4e-4c7a-a1d2-6e5f4c3b2a10",
    "firstName": "Alice",
    "lastName": "Smith",
    "email": "alice.smith@example.com",
    "mobile": "+44 7700 900123",
    "mainAddress": {
      "name": "Home",
      "line1": "12 High Street",
      "line2": null,
      "line3": null,
      "line4": null,
      "town": "London",
      "postcode": "SW1A 1AA",
      "state": null,
      "country": "GB",
      "recipient_name": "Alice Smith"
    },
    "giftAidAddress": null,
    "taxReceiptAidAddress": null,
    "created": 1709200000,
    "updated": 1714000000,
    "consentAsked": true,
    "consentStatus": "active",
    "consentChannels": "email,sms",
    "externalId": "EXT-G-001",
    "smsOptIn": true,
    "companyName": null
  }
]
Every guest record carries three consent fields:
FieldTypeDescription
consentAskedbooleanWhether the guest has been prompted for consent.
consentStatusStatus enumTypically "active" or "inactive" for consent records.
consentChannelsstringComma-separated channels the guest has opted in to (e.g. email,sms,post). Empty string when none.
The consent record is owned by the event (CLIENT consent owner), not a multi-tenant consent platform — opt-in choices apply to communication from the event organizer.

​
Address fields

Each guest may have up to three AddressDetail records:
FieldPurpose
mainAddressPrimary postal address.
giftAidAddressUK Gift Aid declaration address.
taxReceiptAidAddressUS tax-receipt address.
All three may be null. See AddressDetail for the field-by-field reference (note the snake_case recipient_name field).