The identity and technical contract details declared by the specification.
sessions-enrollment-paginated-response
object
Represents a paginated collection of session registration objects.
2 properties
2 required
attendee-response.json
object
Response object indicating the status of send email request for a particular attendee.
3 properties
2 required
TaxSchedule
object
A tax schedule used for location-based tax calculation.
3 properties
2 required
transaction-details-paginated-response
object
The response from a request to list of transactions. This includes the paging object as well.
2 properties
2 required
RefundPolicy
object
Refund policy associated to a fee.
4 properties
taxes-paginated-response
object
A response of tax objects.
2 properties
2 required
session-checkin-bulk-update
array
A list of session check-ins to be updated in bulk.
transaction-detail-response
object
This is used to denote the details of the transaction made by an attendee.
18 properties
ProductType2
string
Represents a product's type. AdmissionItem: Product is a ticket to an event, typically denotes the day(s) the individual is attending. Every attendee must have…
Fee
object
Fee for a product.
2 properties
event-paginated-response
object
Represents a paginated collection of event objects.
2 properties
2 required
attendee-add-bulk-item-event.json
object
This entity is used to represent a single item that is returned as part of a bulk request call.
1 property
planner.json2
object
Represents the planner of an event.
31 properties
event-question-choices-response
object
Response to the request to get a list of event question choices.
2 properties
1 required
EarlyBirdPricing
object
Early bird pricing for a fee, where attendees receive a discounted fee if they register before a given date.
4 properties
uuid-property
string
A string that has to be a format matching the industry standard uuid
event-questions-paginated-response
object
Represents the response from a request to get the list of event questions. This includes the paging object as well as the collection of event questions.
2 properties
2 required
VoucherCapacity
object
Represents the capacity details for a voucher, including the total allowed redemptions and the number already redeemed.
2 properties
2 required
TransactionItemCreate
object
The item in the created transaction.
2 properties
ErrorResponse
object
Represents an error response with additional details of cascading error messages.
1 property
2 required
Product
object
Represents a product. Products are items that can be purchased during registration.
1 property
session-checkin-base.json
object
Base model for a session check-in.
4 properties
1 required
paging.json2
object
Represents pagination information for a collection of resources.
5 properties
1 required
event-update
object
Represents updates to an event.
3 properties
venue-address.json
object
Venue Address details
5 properties
locale.json
string
Locale code
quantity-item
object
Represents a quantity item. A quantity item allows invitees to specify the amount of a particular product, such as raffle tickets, t-shirts, or tote bags, they…
10 properties
1 required
email.json1
object
Details of an email to be send.
1 property
1 required
OrderRef
object
Represents an order by its ID and includes the order type.
2 properties
sessions-checkin-paginated-response
object
Paginated collection of session attendance objects.
2 properties
2 required
session-bulk-checkin
array
Represents a list of session check-ins.
event-async-response
object
Asynchronous event operation job details.
2 properties
2 required
event-async-status
object
Status of an event asynchronous operation.
1 property
DiscountDetail
object
This is used to denote the discount details
6 properties
event-emails-paginated-response
object
Paginated response for the collection of emails for a specified event.
2 properties
2 required
order-details-paginated-response
object
The response from a request to list of orders. This includes the paging object as well.
2 properties
2 required
error-response
object
Represents an error response with additional details of cascading error messages.
1 property
2 required
quantity-items-paginated-response
object
A paginated response of quantity items objects.
2 properties
2 required
RegistrationTypeID
string
A unique identifier of the registration type
DiscountType
string
This is used to denote the type of discount
registration-type-response
object
Represents the details of an existing registration type.
2 properties
1 required
event.json6
object
Details of the event.
1 property
1 required
planning-document.json
object
Represents a planning document associated with an event.
6 properties
admission-items-paginated-response
object
Paginated collection of admission items.
2 properties
2 required
order-items-paginated-response
object
The response from a request to list of order items. This includes the paging object as well.
2 properties
2 required
custom-field.json2
object
A Custom Field
1 property
custom-field2
object
A Custom Field
1 property
attendee-add-bulk-item
object
This entity is used to represent a single item that is returned as part of a bulk request call.
1 property
link.json
object
Represents a link to a related resource.
1 property
1 required
sessions-enrollment.json
object
Represents the attendee registration action for a session.
6 properties
session-enrollment-status.json
string
Denotes the attendee's status in the session. Registered: The attendee is registered for the session. Waitlisted: The attendee is on a waitlist to register for…
event-question-choice.json
object
This is used to denote the choice of questions in an event.
1 property
1 required
invitation-list-id.json
object
Object encapsulating invitation list id
1 property
1 required
stakeholder.json
object
Represents an event stakeholder.
30 properties
existing-registration-type-with-associated-reg-path.json
object
Represents the details of an existing registration type and registration path associated to it.
1 property
1 required
GeneralLedger
object
This is used to denote the general ledger detail in an order item
5 properties
AGeneralLedgerCodeUsedToCategorizeFinancialDataWhichHelpsBusinessesAnalyzeAndReportOnTheirFinancialActivity
object
A general ledger code associated to a fee.
1 property
event-copy
object
Represents directives for the event copy operation.
8 properties
invitation-list.json
object
Object encapsulating relevant information about an invitation list.
4 properties
1 required
user-groups-paginated-response
object
Contains a paginated list of user groups associated with an event
2 properties
2 required
send-email-event-response
object
Response object containing a request ID and a list of all email responses sent to attendees.
4 properties
4 required
planning-document-reference-link.json
object
A reference link contains the URL that provides direct access to download the file for the document. The expiration of the URL can be included if applicable.
2 properties
user-group.json1
object
Contains information about a user group associated with an event
2 properties
2 required
event-security-level.json
string
Represents the security level used for event registrations.
fee-items-paginated-response
object
A response of fee item objects.
2 properties
2 required
attendees-paginated-response
object
A paginated response containing a list of attendees who have redeemed a voucher.
2 properties
2 required
invitation-list-paginated-response
object
Return a response object containing paginated data for the invitation list(s).
2 properties
2 required
order-detail
object
This is used to denote the details of the order made by an attendee.
14 properties
send-email-event-request
object
Request object to send an email to one or more event attendees.
4 properties
4 required
Attendee2
object
The reference to the attendee. Contains only the ID of the attendee.
1 property
1 required
donation-items-paginated-response
object
A paginated response of donation items objects.
2 properties
2 required
Product-1
object
Represents a product. Products are items that can be purchased during registration.
3 properties
attendee-add-bulk-response-event
array
List of attendee check-in responses.
transaction-items-paginated-response
object
The response from a request to list of transactions. This includes the paging object as well.
2 properties
2 required
event-links.json
object
Represents the links associated with an event.
4 properties
filter
object
A filter which is sent through the body of the request.
1 property
GeneralLedger1
object
This is used to denote the general ledger code associated with donation item.
3 properties
associated-registration-path.json
object
Represents the details of a registration path.
1 property
1 required
create-transaction-request
object
Denotes the details of the transaction created for an attendee.
15 properties
3 required
PaymentMethod
string
This denotes the payment method in a transaction.
event-format.json
string
Denotes the format of an event.
Tax
object
A tax is an event-level pricing configuration applied to products such as admission items, sessions, and other billable items.
9 properties
4 required
BillingAddress
object
Billing Address Details
2 properties
event-status.json
string
Event status denotes if the event is in the past, present or future. Also can denote if the event was cancelled or deleted.
OrderItemRef
object
Represents an order item by its ID.
1 property
1 required
event
object
Represents an event.
37 properties
6 required
registration-path-paginated-response
object
Represents a paginated collection of registration paths.
2 properties
2 required
event-question.json
object
Represents a question associated with an event.
9 properties
FeeItem
object
A fee item is a fee associated with something an agenda item at the event. A given agenda item can have one or more fee items associated.
12 properties
send-email-status.json
string
It is used to denote the status of the sent email.
sessions-attendance-response.json
object
Represents session attendance details.
8 properties
TransactionId
object
This is used to denote the id and merchant/processor transaction id for transaction items.
2 properties
1 required
paging.json
object
Represents pagination information for a collection of resources.
6 properties
1 required
membership-items-paginated-response
object
A paginated response of membership items.
2 properties
2 required
Event
object
The reference to the event. Contains only the ID of the event.
1 property
1 required
Anniversary
object
Represents an anniversary-based membership item that renews on the anniversary date of the original purchase.
3 properties
1 required
existing-admission-item
object
Represents an existing event admission item.
2 properties
RefundType
string
The type of refund policy for the fee. RefundByFixedAmount: Returns a fixed amount to the attendee as chosen by the planner. RefundByCancellationAmount: Refund…
order-item-response
object
This is used to denote an item in the order
20 properties
quantity-item-update
object
Represents details for updating a quantity item for an attendee's registration.
4 properties
3 required
PaymentType
string
Denotes the type of transaction you're creating. Offline Charge: The transaction is a payment made to the attendee's order electronically in another system of…
event-email.json
object
An email and its details for a specific event.
3 properties
2 required
ProductOrderItem
object
This is used to denote the product details in an order item
2 properties
event-copy-target.json
object
Represents the target event information for an event copy operation.
1 property
existing-registration-path.json
object
Represents the details of an existing registration path.
1 property
Paging
object
Represents pagination information for a collection of resources.
6 properties
1 required
order-item-associate-discount
object
Details for order item update while associating a discount code
4 properties
4 required
send-email-request-status.json
string
Denotes the status of the send email request.
OrderItem
object
Represents an order item. Contains only the ID of the order item.
1 property
1 required
capacity.json
object
Represents capacity statistics of the registration type.
3 properties
1 required
ErrorResponseBase
object
Represents an error response with no additional details.
3 properties
2 required
Order
object
Represents an order. Contains only the ID of the order.
1 property
1 required
choice-type.json
string
The type for the event question choice.
ProductType
string
This is used to denote the product type.
DonationItem1
object
Represents a donation item. Donation items give event invitees the option to contribute money to an association, charity, or cause during registration.
10 properties
create-transaction-response
bulk-checkin
array
Collection of check-ins.
attendee-add-bulk-response1
array
List of attendee check-in responses.
registration-type-paginated-response
object
Represents a paginated collection of registration types.
2 properties
2 required
checkin.json
object
Represents event check-in details.
5 properties
2 required
registration-status.json
string
This is used to denote the registration status for an event.
event-type.json
string
Type of event being created. The following event types are not supported: Cvent Webinar, Cvent Essentials.
BaseAddress
object
Base Address Model
6 properties
planning-document-event-id.json
object
Event associated with the document.
1 property
membership-item
object
Represents a membership item. Membership items are products that can be purchased during registration or on contact websites.
13 properties
PaymentType-1
string
Denotes the type of payment made by an attendee. Authorization: Online payment that has been approved by the cardholder's bank but has not been executed. Onlin…
OrderType
string
This is used to denote the type of order made by an attendee.
transaction-item-response
object
This is used to denote an item in the transaction.
10 properties
vouchers-paginated-response
object
A paginated response of vouchers.
2 properties
2 required
attendee-add-bulk-item.json
object
This entity is used to represent a single item that is returned as part of a bulk request call.
1 property
venue.json
object
An Event Venue
2 properties
planning-documents-paginated-response
object
Represents a paginated collection of event planning documents.
2 properties
2 required
Link
object
Represents a link to a related resource.
1 property
1 required
Audit
object
Audit information
4 properties
session1
object
Represents an event session.
22 properties
voucher
object
Represents a voucher configured for an event. Event-level vouchers are special codes that can be assigned to invitees or attendees, enabling benefits such as f…
7 properties
2 required
Calendar
object
Represents a calendar-based membership item that renews according to calendar periods.
2 properties
1 required
uuid.json
object
The reference to the related entity. Contains only the ID of the related entity.
1 property
1 required
optout-by.json
string
This is used to denote how a contact is opt'd out of Cvent system.
PaginationLinks
object
Represents pagination links for navigating between pages of data.
3 properties
question-type.json1
string
This object represents the type of a question
session-checkin-create.json
object
Represents an attendee to be checked into a session.
1 property
1 required
pagination-links.json
object
Represents pagination links for navigating between pages of data.
3 properties
Attendee
object
The reference to the attendee. Contains only the ID of the attendee.
1 property
1 required
Guest
object
The reference to the guest. Contains only the ID of the guest.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cvent Event Cloud publishes across the network.