API-Keys
GETADITUS/Attendees/Attendees – Base GET - all parameters

Attendees – Base GET - all parameters

GET{{API_BASE_URL}}/terp/v1/events/{{EVENT_ID}}/attendees

Get Event Attendees

Overview

Retrieves a list of attendees/registrations for a specific event. This endpoint provides comprehensive attendee data including ticket information, custom fields, and registration details. It supports various filtering and pagination options to efficiently retrieve attendee records.

Authentication

This endpoint requires API authentication using:

  • KEY: API key for authentication (stored in {{KEY}} variable)

  • SECRET: API secret for authentication (stored in {{SECRET}} variable)

These credentials should be configured in your environment or collection variables.

Path Parameters

ParameterTypeRequiredDescription
eventIdstringYesThe unique identifier of the event for which to retrieve attendees. Use {{eventId}} variable.

Query Parameters

Pagination & Filtering

ParameterTypeDefaultDescription
sinceRegistrationIdinteger0Retrieve attendees with registration IDs greater than this value. Useful for incremental syncing. Examples: 0, 869300, or use {{lastMaxRegistrationId}}
limitinteger2500Maximum number of attendees to return in a single request. Examples: 1, 5, 30, 2500
ticketCodestring-Filter attendees by a specific ticket code. Example: AW4F9QKM7T3XQ4 or use {{ticketCode}}
EMail / email / eMailstring-Filter attendees by email address. Note: Multiple parameter name variations exist for compatibility.
externalId1string-Filter by first external identifier
externalId2string-Filter by second external identifier
externalId3string-Filter by third external identifier
saleIdGUID-The unique identifier of the sale (e.g., received via webhook).

Inclusion Options

Ticket Owner Update Inclusion Options

The API provides flexible options for including updates to ticket owner information in the result set. These options allow you to control both the completeness and the structure of the returned data, depending on your requirements for data accuracy and performance.

includingTicketOwnerUpdates

  • Type: boolean

  • Default: false

  • Description:
    When set to true, the API includes updates to ticket owner information in the results. This means that any changes to the ticket owner (for example, when the country was changed) are reflected in the data returned by the API.

    • If includingTicketOwnerUpdates is false, ticket owner changes are not included in the result set.

IncludingTicketOwnerUpdatesWithoutDuplication

  • Type: boolean

  • Default: true

  • Description:
    This parameter controls whether multiple updates to the same ticket owner are consolidated in the result set or returned as separate entries.

    • true (default):
      The API ensures that each registration appears only once in the result set, even if there have been multiple internal updates to the ticket owner. This is achieved by using an internal mechanism that groups together rapid, repeated updates, so only the latest state is returned. This approach prevents duplicate attendee records and provides a clean, deduplicated result set.

    • false:
      All internal ticket owner updates are returned as individual records, even if they are identical. This can result in the same attendee appearing multiple times in the result set (for example, three, four, or more times), depending on how many updates occurred. This mode may offer faster response times in certain scenarios, but requires the client to handle potential duplicates.

Note:

  • The default and recommended setting is IncludingTicketOwnerUpdatesWithoutDuplication = true, which ensures a clean result set without duplicates.

  • Setting this parameter to false may be useful if you require the fastest possible response and can handle duplicate records in your application logic.

ParameterTypeDefaultDescription
includingTicketOwnerUpdatesbooleanfalseInclude updates to ticket owner information in the results
IncludingTicketOwnerUpdatesWithoutDuplicationbooleantrueInclude ticket owner updates without duplicating records
includingCancellations / includingCancelationsbooleanfalseMeaning depends on use case, see use case for details.
includingBlockedTicketsbooleanfalseMeaning depends on use case, see use case for details.
includingBlockedLegitimationsbooleantrueInclude blocked legitimations. Example: true
includingCustomFieldsValuebooleanfalseInclude custom field values in the attendee data

Custom Fields Configuration

ParameterTypeDefaultDescription
customFieldsLookupListNamestring-Name of the custom fields lookup list to use. Examples: [MANDATOR]_PROFILDATEN_GESAMT, Profile_BASIS
customFieldsLookupLanguagestring-Language for custom field lookups. Examples: DefaultSystemLanguage, de
customFieldValuesSeparatorstring,Character used to separate multiple custom field values. Default: comma (,)
customFieldsFilteringbooleanfalseEnable filtering based on custom fields.
QPA[EVENT-YEAR]-[EVENT-NR.]_*
customFieldsFilteringsSimpleFaireventListstringEnable filtering based on custom fields. Example: 1003,1004,1005
QPA_
customFieldsFilteringIgnorestringPersonInfo1Ignore filtering on custom fields.

Data Processing Options

ParameterTypeDefaultDescription
useOwnerEMailbooleanfalseOnly for use case by ticket code
If this parameter is set to true, the result will also contain all other registrations we have for the barcode holder's email

Headers

HeaderValueDescription
Acceptapplication/jsonSpecifies the expected response format (JSON)

Example Use Cases

1. Basic Attendee Retrieval

Retrieve all attendees for an event:

GET {{API_BASE_URL}}/terp/v1/events/{{EVENT_ID}}/attendees

2. Incremental Sync with Pagination

Retrieve new registrations since the last sync:

GET {{API_BASE_URL}}/terp/v1/events/{{EVENT_ID}}/attendees?sinceRegistrationId={{lastMaxRegistrationId}}&limit=2500

3. Find Attendee by Ticket Code

Look up a specific attendee using their ticket code:

GET {{API_BASE_URL}}/terp/v1/events/{{EVENT_ID}}/attendees?ticketCode=AW4F9QKM7T3XQ4

4. Find Attendee by Email

Search for an attendee by email address:

GET {{API_BASE_URL}}/terp/v1/events/{{EVENT_ID}}/attendees?email=example@domain.com

5. Comprehensive Data with Custom Fields

Retrieve attendees with all available data including custom fields and cancellations:

GET {{API_BASE_URL}}/terp/v1/events/{{EVENT_ID}}/attendees?includingCustomFieldsValue=true&customFieldsLookupListName=Profile_BASIS&customFieldsLookupLanguage=de&includingCancelations=true&includingTicketOwnerUpdates=true

Response

The endpoint returns a JSON array of attendee objects containing registration details, ticket information, and optionally custom field data based on the query parameters provided.

Notes

  • Use pagination (limit and sinceRegistrationId) for large events to avoid timeouts

  • Boolean parameters accept true or false values

  • The API_BASE_URL variable should point to your ADITUS API environment

Authentication#auth

This endpoint does not require authentication.

Query parameters#query

eMailoptional

Filters by attendee email address (case‑insensitive exact match; one value only, encode).

externalId1optional

(Optional) See With externalId

externalId2optional

(Optional) See With externalId

externalId3optional

(Optional) See With externalId

ticketCodeoptional

The barcode, quicode, registration code or ticketUniqueId

useOwnerEMailfalseoptional

(Optional) If this parameter is set to true, the result will also contain all other registrations we have for the barcode holder's email

saleId6054807e-d505-f111-93e3-00155d960409optional

Querying all attendees belonging to a specific sale transaction using the saleId.

sinceRegistrationId0optional

Represents an offset for registrations that have already been transmitted. A full-load (sinceRegistrationId = 0) should only be carried out once a day, not more than 3 times a day.

limit5optional

(Optional) Number of items per response. Default value : 2500 A high limit can cause the request to time out if it takes longer than 30 seconds. Please choose the limit accordingly.

includingTicketOwnerUpdatesfalseoptional

If set to true, all update actions for the ticket owner will also be included. Only for delta loads. Do not set it for initial, full loads.

IncludingTicketOwnerUpdatesWithoutDuplicationtrueoptional

If set to false, his may result in duplicate results but the result ist faster.

includingCancellationsfalseoptional

Meaning depends on use case, see use case for details.

includingBlockedTicketsfalseoptional

Meaning depends on use case, see use case for details.

includingBlockedLegitimationstrueoptional

If uncompleted legitimisations are not to be output, the parameter must be explicitly set to false. If the behaviour is changed, this can have an impact on paging. Currently, completed legitimations cannot be transmitted after completion. If this information is required, a full-load is currently recommended. (sinceRegistrationId = 0)

includingCustomFieldsValuefalseoptional

If this parameter is set to true, a value list resolving is performed. The JSON changes, resolved values are contained in customField*Value.

customFieldsLookupListNamePROFILDATEN_GESAMToptional

To change the value list for resolving value list keys

customFieldsLookupLanguageDefaultSystemLanguageoptional

To change the language for resolving value list keys

customFieldValuesSeparator,optional

To change the separator between values

customFieldsFilteringfalseoptional

Enable filtering based on custom fields.
QPA[EVENT-YEAR]-[EVENT-NR.]_*

customFieldsFilteringsSimpleFaireventListoptional

Enable filtering based on custom fields. Example: 1003,1004,1005 QPA_*

customFieldsFilteringIgnorePersonInfo1optional

Ignore filtering on custom fields.

Responses#responses

No example responses on file.