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
).
Event.courseRegistrations.limit
● PaginationLimit!
non-null scalar
Event.courseRegistrations.offset
● NonNegativeInt!
non-null scalar
Event.createdAt
● DateTime!
non-null scalar
The date and time the record was created.
Event.createdBy
● String
scalar
UTF-8 string value that represents the username of the user who created the record. Optional.
Event.currencies
● [Currency!]!
non-null object
A list of supported currencies for the event.
Event.customFieldDefinitions
● EventScopedCustomFieldDefinitions!
non-null object
A list of custom field definitions associated with this event. The provided key identifies which type of object the fields relate too.
Event.customFields
● [CustomField!]!
non-null object
A list of custom field values associated with this event.
CustomField
s and CustomFieldDefinition
s can be matched through the definitionId
and id
fields, respectively.
See CustomFieldSearchFilterInput
for details on how the optional input
argument can be used to filter custom fields.
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.customFields.input
● CustomFieldSearchFilterInput!
non-null input
Event.customFields.limit
● PaginationLimit!
non-null scalar
Event.customFields.offset
● NonNegativeInt!
non-null scalar
Event.defaultCurrency
● Currency!
non-null object
A default currency for the event.
Event.emailMessagingService
● EmailMessagingService
object
The external connected service integrated with this event for email messaging. Optional.
Event.endDate
● LocalDate!
non-null scalar
The end date of the event.
Event.exhibitionBooking
● ExhibitionBooking!
non-null object
Retrieves an exhibition booking by its identifier. Throws an error with code NOT_FOUND
if no exhibition booking is found.
Event.exhibitionBooking.id
● ID!
non-null scalar
Event.exhibitionBookings
● [ExhibitionBooking!]!
non-null object
The exhibitions that have been booked for this event.
See ExhibitionBookingSearchFilterInput
for details on how the optional input
argument can be used to filter exhibition bookings.
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.exhibitionBookings.input
● ExhibitionBookingSearchFilterInput!
non-null input
Event.exhibitionBookings.limit
● PaginationLimit!
non-null scalar
Event.exhibitionBookings.offset
● NonNegativeInt!
non-null scalar
Event.functionRegistrations
● [FunctionRegistration!]!
non-null object
Function registrations for this event that match the filter criteria specified in the optional filterInput
argument.
See FunctionRegistrationSearchFilterInput
for details on how the filterInput
argument can be used to filter function registrations.
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
).
Rules:
- Only one of
filterInput
andinput
should be specified. - The
filterInput
argument will take precedence over theinput
argument.
Throws an error with code: BAD_USER_INPUT
if all fields in the filterInput
or input
arguments have a combined total number of values exceeding 1,000
Event.functionRegistrations.filterInput
● FunctionRegistrationSearchFilterInput!
non-null input
Event.functionRegistrations.input
● FunctionRegistrationFilterInput!
deprecated non-null input
Use filterInput
instead. This argument will be removed in a future release.
Event.functionRegistrations.limit
● PaginationLimit!
non-null scalar
Event.functionRegistrations.offset
● NonNegativeInt!
non-null scalar
Event.group
● EventGroup
object
The event group that this event is associated with. Optional.
Event.hotelBookings
● [HotelBooking!]!
non-null object
The hotel bookings for this event.
See HotelBookingSearchFilterInput
for details on how the optional input
argument can be used to filter hotel bookings.
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.hotelBookings.input
● HotelBookingSearchFilterInput!
non-null input
Event.hotelBookings.limit
● PaginationLimit!
non-null scalar
Event.hotelBookings.offset
● NonNegativeInt!
non-null scalar
Event.id
● ID!
non-null scalar
The unique identifier for an event.
Event.invoice
● Invoice!
non-null object
Retrieves an invoice by its identifier. Throws an error with code NOT_FOUND
if no invoice is found.
Event.invoice.id
● ID!
non-null scalar
Event.invoiceConfiguration
● InvoiceConfiguration
object
Specifies the configuration of invoices for this event. Optional.
Event.invoices
● [Invoice!]!
non-null object
Invoices for this event that match the filter criteria specified in the optional input
argument.
See InvoiceSearchFilterInput
for details on how the optional input
argument can be used to filter invoices.
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.invoices.input
● InvoiceSearchFilterInput!
non-null input
Event.invoices.limit
● PaginationLimit!
non-null scalar
Event.invoices.offset
● NonNegativeInt!
non-null scalar
Event.lastModifiedAt
● DateTime!
non-null scalar
The date and time the record was last modified.
Event.lastModifiedBy
● String
scalar
UTF-8 string value that represents the username of the user who last modified the record. Optional.
Event.link
● Link!
non-null object
Retrieves a link by its identifier. Throws an error with code NOT_FOUND
if no link is found.
Event.link.id
● ID!
non-null scalar
Event.links
● [Link!]!
non-null object
The list of links for this event.
Event.logo
● Image
object
The logo for the event. Optional.
Event.marketingRecords
● [EventMarketingRecord!]!
non-null object
The marketing records 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.marketingRecords.limit
● PaginationLimit!
non-null scalar
Event.marketingRecords.offset
● NonNegativeInt!
non-null scalar
Event.meetingPreferences
● EventMeetingPreferences!
non-null object
The meeting preferences for this event.
Event.meetingSchedule
● MeetingSchedule!
non-null object
Retrieves a meeting schedule by its identifier. Throws an error with code NOT_FOUND
if no meeting schedule is found.
Event.meetingSchedule.id
● ID!
non-null scalar
Event.meetingSchedules
● [MeetingSchedule!]!
non-null object
A list of meeting schedules for this event.
EventsAir includes Meeting Matching tools that allow event exhibitors to schedule meetings with attendees.
See MeetingScheduleSearchFilterInput
for details on how the optional input
argument can be used to filter exhibition bookings.
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 have a combined total number of values exceeding 1,000
Event.meetingSchedules.input
● MeetingScheduleSearchFilterInput!
non-null input
Event.meetingSchedules.limit
● PaginationLimit!
non-null scalar
Event.meetingSchedules.offset
● NonNegativeInt!
non-null scalar
Event.mergeDocuments
● [MergeDocument!]!
non-null object
A list of Merge Documents 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.mergeDocuments.limit
● PaginationLimit!
non-null scalar
Event.mergeDocuments.offset
● NonNegativeInt!
non-null scalar
Event.name
● String!
non-null scalar
A UTF-8 string representing the name of an event.
Event.notes
● [EventNote!]!
non-null object
The notes 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.notes.limit
● PaginationLimit!
non-null scalar
Event.notes.offset
● NonNegativeInt!
non-null scalar
Event.office
● Office!
non-null object
The office that manages the event.
Event.onlinePaymentServices
● OnlinePaymentServices!
non-null object
The external connected services integrated with this event for online payment processing.
Event.payment
● Payment!
non-null object
Retrieves a payment by its identifier. Throws an error with code NOT_FOUND
if no payment is found.
Event.payment.id
● ID!
non-null scalar
Event.payments
● [Payment!]!
non-null object
Payments for this event that match the filter criteria specified in the optional input
argument.
See PaymentSearchFilterInput
for details on how the optional input
argument can be used to filter payments.
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.payments.input
● PaymentSearchFilterInput!
non-null input
Event.payments.limit
● PaginationLimit!
non-null scalar
Event.payments.offset
● NonNegativeInt!
non-null scalar
Event.portal
● EventPortal!
non-null object
Retrieves a portal by its identifier. Throws an error with code NOT_FOUND
if no portal is found.
Event.portal.id
● ID!
non-null scalar
Event.portals
● [EventPortal!]!
non-null object
The portals configured in this event.
Event.presentations
● [Presentation!]!
non-null object
The presentations for this event.
See PresentationSearchFilterInput
for details on how the optional input
argument can be used to filter presentations.
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.presentations.input
● PresentationSearchFilterInput!
non-null input
Event.presentations.limit
● PaginationLimit!
non-null scalar
Event.presentations.offset
● NonNegativeInt!
non-null scalar
Event.presenters
● [Contact!]!
non-null object
Presenters for an event ordered by name (ascending).
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.presenters.limit
● PaginationLimit!
non-null scalar
Event.presenters.offset
● NonNegativeInt!
non-null scalar
Event.registration
● Registration!
non-null object
Retrieves a registration by its identifier. Throws an error with code NOT_FOUND
if no registration is found.
Event.registration.id
● ID!
non-null scalar
Event.registrations
● [Registration!]!
non-null object
Registrations for this event that match the filter criteria specified in the optional filterInput
argument.
See RegistrationSearchFilterInput
for details on how the filterInput
argument can be used.
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
).
Rules:
- Only one of
filterInput
andinput
should be specified. - The
filterInput
argument will take precedence over theinput
argument.
Throws an error with code: BAD_USER_INPUT
if all fields in the filterInput
or input
arguments have a combined total number of values exceeding 1,000
Event.registrations.filterInput
● RegistrationSearchFilterInput!
non-null input
Event.registrations.input
● RegistrationFilterInput!
deprecated non-null input
Use filterInput
instead. This argument will be removed in a future release.
Event.registrations.limit
● PaginationLimit!
non-null scalar
Event.registrations.offset
● NonNegativeInt!
non-null scalar
Event.sessions
● [Session!]!
non-null object
The sessions for this event ordered by date (ascending), then by start time (ascending).
See SessionSearchFilterInput
for details on how the optional input
argument can be used to filter sessions.
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.sessions.input
● SessionSearchFilterInput!
non-null input
Event.sessions.limit
● PaginationLimit!
non-null scalar
Event.sessions.offset
● NonNegativeInt!
non-null scalar
Event.setup
● EventSetup!
non-null object
The setup for the event.
Event.sponsorships
● [Sponsorship!]!
non-null object
A list of sponsorships for this event.
See SponsorshipSearchFilterInput
for details on how the optional input
argument can be used to filter sponsorships.
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.sponsorships.input
● SponsorshipSearchFilterInput!
non-null input
Event.sponsorships.limit
● PaginationLimit!
non-null scalar
Event.sponsorships.offset
● NonNegativeInt!
non-null scalar
Event.startDate
● LocalDate!
non-null scalar
The start date of the event.
Event.textMessagingService
● TextMessagingService
object
The external connected service integrated with this event for text messaging. Optional.
Event.timezone
● TimeZone!
non-null scalar
The timezone for the event.
Event.travelBookings
● [TravelBooking!]!
non-null object
The travel bookings for this event.
See TravelBookingSearchFilterInput
for details on how the optional input
argument can be used to filter travel bookings.
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.travelBookings.input
● TravelBookingSearchFilterInput!
non-null input
Event.travelBookings.limit
● PaginationLimit!
non-null scalar
Event.travelBookings.offset
● NonNegativeInt!
non-null scalar
Event.uniqueCode
● String
scalar
A customer supplied, UTF-8 string value that represents a unique code for the event. Optional.
The value must be unique across all events for a tenant.
Event.userAccessRights
● UserAccessRights!
deprecated non-null object
Use accessRights
instead. This field will be removed in a future release.
Indicates which users in EventsAir can access this event.
Event.venue
● EventVenue
object
The venue for the event. Optional.
Returned By
Member Of
CeContactStore
object ● ContactStore
object ● MembershipContactStore
object ● UpdateEventPayload
object