> ## Documentation Index
> Fetch the complete documentation index at: https://developers.momogood.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List guests for an event

> Guests registered for the event with consent metadata. Custom Data Export, Salesforce, and Blackbaud variants.

Lists guests registered for an event, joined with their consent record. Available across all three families:

| Family             | Path                                               | Payload                                                            |
| ------------------ | -------------------------------------------------- | ------------------------------------------------------------------ |
| Custom Data Export | `GET /<your-namespace>/v1/events/{eventId}/guests` | Full record including `externalId`, `smsOptIn`, and `companyName`. |
| Salesforce         | `GET /salesforce/v1/events/{eventId}/guests`       | Lean record. Omits `externalId`, `smsOptIn`, and `companyName`.    |
| Blackbaud          | `GET /blackbaud/v1/events/{eventId}/guests`        | Same as Salesforce variant.                                        |

## Authorization

<Tabs>
  <Tab title="Custom Data Export">
    The authenticated caller must be the dedicated service user provisioned for your integration, and have access to the event.

    <Note>
      Custom Data Export endpoints require a dedicated service user provisioned per customer. Contact [support@givergy.com](mailto:support@givergy.com) to set up your integration.
    </Note>
  </Tab>

  <Tab title="Salesforce">
    The authenticated caller must have access to the event. No dedicated-user restriction.

    <Note>
      The Salesforce connector is a partner-specific integration. Contact [support@givergy.com](mailto:support@givergy.com) to enable the connector for your organization.
    </Note>
  </Tab>

  <Tab title="Blackbaud">
    The authenticated caller must have access to the event. No dedicated-user restriction.

    <Note>
      The Blackbaud connector is a partner-specific integration. Contact [support@givergy.com](mailto:support@givergy.com) to enable the connector for your organization.
    </Note>
  </Tab>
</Tabs>

## Path parameters

| Name      | Type | Notes                                                                        |
| --------- | ---- | ---------------------------------------------------------------------------- |
| `eventId` | UUID | EMS event id (returned by [List events](/events-auctions/endpoints/events)). |

## Query parameters

| Name     | Type   | Default      | Notes                                     |
| -------- | ------ | ------------ | ----------------------------------------- |
| `q`      | string | `""`         | Full-text search across name, email, etc. |
| `since`  | long   | `1606062358` | `updated >= since`.                       |
| `offset` | int    | `0`          | Pagination offset.                        |
| `limit`  | int    | `1000`       | Page size. Maximum `1000`.                |

## Response

<Tabs>
  <Tab title="Custom Data Export">
    [`Guest[]`](/events-auctions/schemas#guest-custom-data-export-variant) — Custom Data Export variant. Includes `externalId`, `smsOptIn`, and `companyName` fields not present on the connector variants.
  </Tab>

  <Tab title="Salesforce">
    [`SalesforceGuest[]`](/events-auctions/schemas#guest-connector-variants-salesforce-and-blackbaud) — a lean variant of `Guest`. Compared to the Custom Data Export payload, the Salesforce guest object **omits** `externalId`, `smsOptIn`, and `companyName`.

    Use the Custom Data Export endpoint if you need any of those three fields.
  </Tab>

  <Tab title="Blackbaud">
    [`BlackbaudGuest[]`](/events-auctions/schemas#guest-connector-variants-salesforce-and-blackbaud) — same shape as `SalesforceGuest`. Omits `externalId`, `smsOptIn`, and `companyName`.

    Use the Custom Data Export endpoint if you need any of those three fields.
  </Tab>
</Tabs>

## Example

<Tabs>
  <Tab title="Custom Data Export">
    ```bash theme={null}
    curl --cookie session.cookie \
      '{EMS_BASE_URL}/<your-namespace>/v1/events/8f3c2a1d-9b4e-4c7a-a1d2-6e5f4c3b2a10/guests?since=1714000000&limit=500'
    ```

    ```json theme={null}
    [
      {
        "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
      }
    ]
    ```
  </Tab>

  <Tab title="Salesforce">
    ```bash theme={null}
    curl --cookie session.cookie \
      '{EMS_BASE_URL}/salesforce/v1/events/8f3c2a1d-9b4e-4c7a-a1d2-6e5f4c3b2a10/guests?since=1714000000'
    ```

    ```json theme={null}
    [
      {
        "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": { "...": "see AddressDetail schema" },
        "giftAidAddress": null,
        "taxReceiptAidAddress": null,
        "created": 1709200000,
        "updated": 1714000000,
        "consentAsked": true,
        "consentStatus": "active",
        "consentChannels": "email,sms"
      }
    ]
    ```
  </Tab>

  <Tab title="Blackbaud">
    ```bash theme={null}
    curl --cookie session.cookie \
      '{EMS_BASE_URL}/blackbaud/v1/events/8f3c2a1d-9b4e-4c7a-a1d2-6e5f4c3b2a10/guests?since=1714000000'
    ```

    Same response shape as the Salesforce variant — omits `externalId`, `smsOptIn`, and `companyName`.
  </Tab>
</Tabs>

## Consent fields

Every guest record carries three consent fields:

| Field             | Type                                                  | Description                                                                                         |
| ----------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `consentAsked`    | boolean                                               | Whether the guest has been prompted for consent.                                                    |
| `consentStatus`   | [`Status` enum](/events-auctions/schemas#status-enum) | Typically `"active"` or `"inactive"` for consent records.                                           |
| `consentChannels` | string                                                | Comma-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`](/events-auctions/schemas#addressdetail) records:

| Field                  | Purpose                          |
| ---------------------- | -------------------------------- |
| `mainAddress`          | Primary postal address.          |
| `giftAidAddress`       | UK Gift Aid declaration address. |
| `taxReceiptAidAddress` | US tax-receipt address.          |

All three may be null. See [`AddressDetail`](/events-auctions/schemas#addressdetail) for the field-by-field reference (note the snake\_case `recipient_name` field).