Event
Represents an EventsAir event.
type Event {
accessRights: AccessRights!
agenda: EventAgenda!
agendaItemAttendances(
input: AgendaItemAttendanceSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [AgendaItemAttendance!]!
alias: String!
associatedContactStore: ContactDataStore
communicationTags(
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [CommunicationTag!]!
contact(
id: ID!
): Contact!
contacts(
input: ContactSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [Contact!]!
courseRegistrations(
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [EventCourseRegistration!]!
createdAt: DateTime!
createdBy: String
currencies: [Currency!]!
customFieldDefinitions: EventScopedCustomFieldDefinitions!
customFields(
input: CustomFieldSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [CustomField!]!
defaultCurrency: Currency!
emailMessagingService: EmailMessagingService
endDate: LocalDate!
exhibitionBooking(
id: ID!
): ExhibitionBooking!
exhibitionBookings(
input: ExhibitionBookingSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [ExhibitionBooking!]!
functionRegistrations(
filterInput: FunctionRegistrationSearchFilterInput! = [object Object]
input: FunctionRegistrationFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [FunctionRegistration!]!
group: EventGroup
hotelBookings(
input: HotelBookingSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [HotelBooking!]!
id: ID!
invoice(
id: ID!
): Invoice!
invoiceConfiguration: InvoiceConfiguration
invoices(
input: InvoiceSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [Invoice!]!
lastModifiedAt: DateTime!
lastModifiedBy: String
link(
id: ID!
): Link!
links: [Link!]!
logo: Image
marketingRecords(
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [EventMarketingRecord!]!
meetingPreferences: EventMeetingPreferences!
meetingSchedule(
id: ID!
): MeetingSchedule!
meetingSchedules(
input: MeetingScheduleSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [MeetingSchedule!]!
mergeDocuments(
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [MergeDocument!]!
name: String!
notes(
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [EventNote!]!
office: Office!
onlinePaymentServices: OnlinePaymentServices!
payment(
id: ID!
): Payment!
payments(
input: PaymentSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [Payment!]!
portal(
id: ID!
): EventPortal!
portals: [EventPortal!]!
presentations(
input: PresentationSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [Presentation!]!
presenters(
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [Contact!]!
registration(
id: ID!
): Registration!
registrations(
filterInput: RegistrationSearchFilterInput! = [object Object]
input: RegistrationFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [Registration!]!
sessions(
input: SessionSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [Session!]!
setup: EventSetup!
sponsorships(
input: SponsorshipSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [Sponsorship!]!
startDate: LocalDate!
textMessagingService: TextMessagingService
timezone: TimeZone!
travelBookings(
input: TravelBookingSearchFilterInput! = [object Object]
limit: PaginationLimit! = 100
offset: NonNegativeInt! = 0
): [TravelBooking!]!
uniqueCode: String
userAccessRights: UserAccessRights! @deprecated
venue: EventVenue
}
Fields
Event.accessRights
● AccessRights!
non-null object
Indicates which users or API keys in EventsAir can access this event.
Event.agenda
● EventAgenda!
non-null object
Specifies the agenda for the event.
Event.agendaItemAttendances
● [AgendaItemAttendance!]!
non-null object
Agenda item attendances for this event that match the filter criteria specified in the optional input
argument.
See AgendaItemAttendanceSearchFilterInput
for details on how the input
argument can be used to filter agenda item attendances.
Optionally, the offset
and limit
arguments can be used to page through multiple items:
offset
must be a non-negative integer (defaults to0
).limit
must be a positive integer from1
to2000
(defaults to100
).
Throws an error with code: BAD_USER_INPUT
if all fields in the input
arguments have a combined total number of values exceeding 1,000
Event.agendaItemAttendances.input
● AgendaItemAttendanceSearchFilterInput!
non-null input
Event.agendaItemAttendances.limit
● PaginationLimit!
non-null scalar
Event.agendaItemAttendances.offset
● NonNegativeInt!
non-null scalar
Event.alias
● String!
non-null scalar
A UTF-8 alphanumeric string representing an alias for an event. The alias is used as part of the URL for websites.
An alias can only contain lower-case, alphameric and hyphen characters: [a-z0-9-]
.
Event.associatedContactStore
● ContactDataStore
union
Specifies the contact store associated with this event. Optional.
Event.communicationTags
● [CommunicationTag!]!
non-null object
A list of communication tags for this event.
Optionally, the offset
and limit
arguments can be used to page through multiple items:
offset
must be a non-negative integer (defaults to0
).limit
must be a positive integer from1
to2000
(defaults to100
).
Event.communicationTags.limit
● PaginationLimit!
non-null scalar
Event.communicationTags.offset
● NonNegativeInt!
non-null scalar
Event.contact
● Contact!
non-null object
Retrieves a contact by its identifier. Throws an error with code NOT_FOUND
if no contact is found.
Event.contact.id
● ID!
non-null scalar
Event.contacts
● [Contact!]!
non-null object
Contacts for this event that match the filter criteria specified in the optional input
argument.
By default, inactive contacts are not returned.
To include inactive contacts in the result set, set input.contactFilter.includeInactive
to true
.
Optionally, the offset
and limit
arguments can be used to page through multiple items:
offset
must be a non-negative integer (defaults to0
).limit
must be a positive integer from1
to2000
(defaults to100
).
Note: the offset
argument must be a multiple of the limit
argument otherwise an error will be thrown. The following table
shows examples of valid and invalid argument value combinations.
limit | offset | Is valid? |
---|---|---|
100 | 0 | ✅ Yes |
100 | 100 | ✅ Yes |
100 | 120 | ❌ No |
50 | 100 | ✅ Yes |
50 | 75 | ❌ No |
250 | 750 | ✅ Yes |
33 | 99 | ✅ Yes |
33 | 100 | ❌ No |
Throws an error with code:
BAD_USER_INPUT
if theoffset
argument is not a multiple of thelimit
argumentBAD_USER_INPUT
if all fields in the input have a combined total number of values exceeding 1,000
Event.contacts.input
● ContactSearchFilterInput!
non-null input
Event.contacts.limit
● PaginationLimit!
non-null scalar
Event.contacts.offset
● NonNegativeInt!
non-null scalar
Event.courseRegistrations
● [EventCourseRegistration!]!
non-null object
The course registrations for this event.
Optionally, the offset
and limit
arguments can be used to page through multiple items:
offset
must be a non-negative integer (defaults to0
).limit
must be a positive integer from1
to2000
(defaults to100
).