Available from version 139 or later.

The new use case By Sale has been introduced, allowing consumers to retrieve all attendees associated with a specific sale transaction – for example, by using the orderId received via webhook (cart.checkedout).

This endpoint is used to retrieve specific personal data for all visitors to a sale, identified by a sale ID. This data includes details of the event and the ticket purchased.

User-Rools

To use this use case, the user must have the following role assigned.

• Required role

  • ApiAttendeeGetBySaleId

• Optional role

  • ApiAttendeeWithAdditionalSalesInformation

Role- and Article-Based Data Access

• Fine-grained access control:
  Third parties can only access attendee registrations for the specific badge categories (articles) and user roles that have been explicitly granted to them. For example, a matchmaking provider may only receive data for VIP and EXHIBITOR categories.

• Standardised roles:
  The API supports a standard set of badge category roles, such as Visitor, Exhibitor, Press, Services, and more. If there are additional badge categories in the system used, corresponding roles must also be created in the system. Please note the naming convention for roles!
  Example roles include:

  • ApiAttendeeBadgeCategoryCONTRACTOR

  • ApiAttendeeBadgeCategoryCREW

  • ApiAttendeeBadgeCategoryDELEGATE

  • ApiAttendeeBadgeCategoryEXHIBITOR

  • ApiAttendeeBadgeCategoryMEDIA

  • ApiAttendeeBadgeCategoryORGANIZER

  • ApiAttendeeBadgeCategoryPRESS

  • ApiAttendeeBadgeCategorySPEAKER

  • ApiAttendeeBadgeCategorySPONSOR

  • ApiAttendeeBadgeCategorySTAFF

  • ApiAttendeeBadgeCategorySTUDENT

  • ApiAttendeeBadgeCategoryVIP

  • ApiAttendeeBadgeCategoryVISITOR

  • ApiAttendeeBadgeCategoryNONE

    • for all articles that do not have a BadgeCategory

If one of these new roles is configured, all other articles will be filtered out. BadgeCategory roles can be combined.

Block-Scoped Payloads

• Modular response structure:
  The API response is organised into logical blocks (such as attendee, address, customFields, termsOfService, ticket, article, booth, exhibitor, additionalSalesInformation).
  Each block can be enabled or disabled based on the assigned user role.

• Default behaviour:
  If no specific role configuration is set, a baseline set of blocks is returned (e.g., attendee, address, customFields, ticket, article, booth, exhibitor)

  • the same as before version 4.135

• Full access roles:
  Special roles are available to grant full access to all attendee or ticket blocks:

  • ApiAttendeeWithAttendeeFullAccess (includes all attendee-related blocks)

    • ApiAttendeeWithAttendeeInformation

    • ApiAttendeeWithAddressInformation

    • ApiAttendeeWithCustomFieldsInformation

    • ApiAttendeeWithTermsOfServicesInformation

    • ApiAttendeeWithUserInformation

  • ApiAttendeeWithTicketFullAccess (includes all ticket-related blocks)

    • ApiAttendeeWithTicketsInformation

    • ApiAttendeeWithArtcleInformation

    • ApiAttendeeWithBoothInformation

    • ApiAttendeeWithExhibitorInformation

    • ApiAttendeeWithBarcodeInformation

    • ApiAttendeeWithTicketLinksInformation

    • ApiAttendeeWithTicketPromotionCodesInformation (available from version 139 or later)

    • ApiAttendeeWithTicketSalePropertiesInformation (available from version 139 or later)

If one of these new roles is configured, all other areas that are not configured will be deactivated. Roles can be combined.