Cvent Attendees API
The Attendee entity primarily refers to the person throughout the lifecycle of an event including registration, enrollment into sessions, and participation. Once contacts are added to events, an Attendee entity is created. This API allows you to read attendee data and add new attendees to your Cvent events.
Cvent Attendees API is one of 65 APIs that Cvent publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Attendees. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
12 operations
across 9 paths,
and defines 66 schemas.
It is described by OpenAPI 3.0.2, at version ea.
Requests are made against 2 base URLs: https://api-platform.cvent.com/ea, https://api-platform-eur.cvent.com/ea.
The identity and technical contract details declared by the specification.
Cvent Attendees API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (OAuth2.clientCredentials) using the clientCredentials flow, exposing 238 scopes.
It supports OAuth 2.0 (OAuth2.authorizationCode) using the authorizationCode flow, exposing 208 scopes.
OAuth2.clientCredentials — OAuth2 Client Credentials Flow.OAuth2.authorizationCode — OAuth2 Authorization Code Flow.
Link
object
Represents a link to a related resource.
1 property
1 required
duration-paginated-response
object
Paginated collection of durations.
2 properties
2 required
CustomFieldType
string
The type of data collected by a custom field.
uuid-property
string
A string that has to be a format matching the industry standard uuid
attendee-internal-info
object
Model representing internal information answers for an attendee to be added or updated.
2 properties
2 required
filter
object
A filter which is sent through the body of the request.
1 property
paging.json
object
Represents pagination information for a collection of resources.
6 properties
1 required
AttendeeResponseMethod
string
Method by which attendee registered for the event. Note: This field is deprecated. Previous documentation incorrectly listed support for this feature.
AttendeeContactMembership
object
Attendee's contact membership information. Note: This field is deprecated. Previous documentation incorrectly listed support for this feature.
7 properties
UUID
object
The reference to the related entity. Contains only the ID of the related entity.
1 property
1 required
AttendeeContactInfo
object
Information about attendee contact added to an event.
1 property
Address4
object
Address details
5 properties
AttendeeContactAudit
object
Audit information for an attendee record. To get contact audit data, please use [Get Contact](/documentationtag/Contacts/operation/getContactById).
4 properties
AttendeeInvitesBulkResponseItem
object
This entity is used to represent a single item that is returned as part of a bulk request call.
1 property
AttendeeStatus
string
This is used to denote the status of an attendee.
AttendeeWebLinks
object
Web links for an attendee.
2 properties
existing-duration
object
An existing duration.
1 property
1 required
Audit
object
Audit information
4 properties
ExternalReference
object
An external reference.
3 properties
attendee-subscription-response
object
Response body for successful attendee subscription status update.
2 properties
2 required
ErrorResponse-12
object
Represents an error response with additional details of cascading error messages.
1 property
2 required
AttendeeBase
object
Model representing an attendee to be added or updated to an event. The status determines if this is an registration or an invite.
11 properties
1 required
BadgeType
string
Badge type
Event4
object
The Associated Event.
1 property
1 required
CustomFieldBase
object
Base schema for Custom Field - allows type to be customized by extending schemas
4 properties
2 required
Lookup
object
Lookup response object
3 properties
pagination-links.json
object
Represents pagination links for navigating between pages of data.
3 properties
AttendeeUpdateStatus
string
Denotes the status of an attendee to be updated. No Response: The attendee was added to an invitation list but hasn't taken any action. Accepted: The attendee…
attendee-add-bulk
array
List of attendees to add.
UUIDProperty
string
A string that has to be a format matching the industry standard uuid
ContactLinks
object
Collection of social media links for the contact.
4 properties
AttendeeContactType
object
Contains details related to the attendee's contact type.
2 properties
badge
object
A JSON Schema for Badge object.
5 properties
5 required
badge-paginated-response
object
Badge List response including paging and badge data.
2 properties
ExternalReferenceType
string
Type of the external system.
AppointmentGroup
object
An appointment group.
1 property
attendee
object
An event attendee.
41 properties
attendee-subscription-request
object
Request body for updating an attendee's email subscription status.
1 property
1 required
AttendeeVisibility
string
Denotes the visibility of the attendee profile to other attendees. Private: Their profile is not visible. Public: Their profile is visible.
ErrorResponseBase1
object
Represents an error response with no additional details.
3 properties
2 required
BaseAddress
object
Base Address Model
6 properties
attendee-paginated-response
object
The response from a request to get the list of attendees. This includes the paging object as well as the collection of attendees.
2 properties
2 required
NamedObject
object
A Named object
2 properties
BulkResponseItem
object
Represents a single item that is returned as part of a Bulk request call.
4 properties
2 required
link.json
object
Represents a link to a related resource.
1 property
1 required
CustomField
object
A Custom Field
1 property
PaginationLinks
object
Represents pagination links for navigating between pages of data.
3 properties
Paging
object
Represents pagination information for a collection of resources.
6 properties
1 required
AttendeeContact
object
An Attendee Contact
33 properties
BadgeStatus
string
Badge status
AttendeeAnswer
object
An attendee's answer to registration questions.
2 properties
2 required
uuid.json
object
The reference to the related entity. Contains only the ID of the related entity.
1 property
1 required
attendee-add-bulk-response
array
List of attendee invitations.
Gender
string
The gender of the contact.
Compliance
object
Privacy compliance fields for a contact.
4 properties
Attendee1
object
The associated Attendee.
1 property
1 required
AttendeeAddResponse
object
AttendeeAddResponse
1 property
AttendeeInvitedBy-1
string
Method by which the attendee was invited to the event.
AttendeeInvitedBy
string
Method by which the attendee was invited to the event. Note: This field is deprecated. Previous documentation incorrectly listed support for this feature.
duration
object
The amount of time that the attendee was engaged (in person or virtually) in a session or watching a video.
9 properties
6 required
attendee-update
object
Model representing an attendee to be updated in an event.
4 properties
3 required
AttendeeAdd
object
Model representing an attendee to be added to an event. The attendee's assigned status determines if this add action is a registration or an invite.
7 properties
2 required
AttendeeAddStatus
string
Denotes the status of an attendee being added. No Response: The attendee was added to an invitation list but hasn't taken any action. Accepted: The attendee is…
AddressType
string
The type of address.
AttendeeResponseMethod-1
string
Represents the method by which an attendee registered for the event. - Administrator Responded: The invitee was registered by another contact acting as their a…
AttendeeGroup
object
An attendee group.
3 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cvent publishes across the network.
