How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cvent Event Cloud Contacts API

Contact/address book

Cvent Event Cloud Contacts API is one of 55 APIs that Cvent Event Cloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Contacts. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 28 operations across 16 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version ea.

Requests are made against 2 base URLs: https://api-platform.cvent.com/ea, https://api-platform-eur.cvent.com/ea.

28 operations 16 paths 56 schemas 5 DELETE9 GET2 PATCH5 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
ea
Base URL
https://api-platform.cvent.com
Authentication
OAuth 2.0, OAuth 2.0, API Key, HTTP Basic
Resource Areas
1

Authentication & Security 4

Cvent Event Cloud Contacts API declares 4 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2.authorizationCode) using the authorizationCode flow, exposing 205 scopes. It supports OAuth 2.0 (OAuth2.clientCredentials) using the clientCredentials flow, exposing 235 scopes. An API key is passed in the header as Authorization (CallbackApiKeyAuth). It accepts HTTP basic authentication (CallbackBasicAuth).

  • OAuth2.authorizationCode — OAuth2 Authorization Code Flow.
  • OAuth2.clientCredentials — OAuth2 Client Credentials Flow.
  • CallbackApiKeyAuth — This security scheme is used to indicate that Cvent should use API Key auth when invoking your callback. This scheme is only supported for callback operations,…
  • CallbackBasicAuth — This security scheme is used to indicate that Cvent should use basic auth when invoking your callback. This scheme is only supported for callback operations, a…

Paths & Operations 28

Across 16 paths, the API surfaces 28 operations — 5 DELETE, 9 GET, 2 PATCH, 5 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Contacts 28

A contact is a record in your account’s address book that represents an individual. The data stored within these records includes personal information, group memberships, and hist…

POST
/contact-groups
Create Contact Group
createContactGroup body → 201400401403429
GET
/contact-groups
List Contact Groups
listContactGroups 5 params → 200400401403429
GET
/contact-groups/{id}
Get Contact Group
getContactGroupById 1 param → 200401403404429
PUT
/contact-groups/{id}
Update Contact Group
updateContactGroup 1 param body → 200400401403404429
DELETE
/contact-groups/{id}
Delete Contact Group
deleteContactGroup 1 param → 204401403404429
GET
/contact-groups/{id}/contacts
Get Ids in Contact Group
getContactIdsByContactGroup 3 params → 200400401403404429
PUT
/contact-groups/{id}/contacts/{contactId}
Add Contact To Group
addContactToContactGroup 2 params → 204401403404429
DELETE
/contact-groups/{id}/contacts/{contactId}
Remove Contact From Group
removeContactFromContactGroup 2 params → 204401403404429
GET
/contact-types
List Contact Types
listContactTypes 3 params → 200400401403429
GET
/contacts
List Contacts
listContacts 6 params → 200400401403429
PUT
/contacts
Update Contacts
updateContacts body → 207400401403429
PATCH
/contacts
Patch Contacts
patchContacts body → 207400401403429
POST
/contacts
Create Contacts
createContacts 1 param body → 207400401403429
POST
/contacts/filter
List Contacts
listContactsPostFilters 4 params body → 200400401403429
GET
/contacts/obfuscate/{obfuscateId}/status
Get Obfuscation Status
getContactObfuscationStatusById 1 param → 200401403404429
GET
/contacts/{contactId}/history
Get Contact Change History
getChangeHistoryForASpecificContact 5 params → 200400401403404429
GET
/contacts/{id}
Get Contact
getContactById 1 param → 200400401403404429
PUT
/contacts/{id}
Update Contact
updateContactById 1 param body → 200400401403404429
PATCH
/contacts/{id}
Patch Contact
patchContactById 1 param body → 200400401403404429
DELETE
/contacts/{id}
Delete Contact
deleteContactById 1 param → 204401403404409429
PUT
/contacts/{id}/custom-fields/{customFieldId}/answers
Update Custom Field Answers
updateContactCustomFieldAnswers 2 params body → 200400401403404429
POST
/contacts/{id}/merge
Merge Contacts
mergeContacts 1 param body → 200400401403404409429
POST
/contacts/{id}/obfuscate
Obfuscate a Contact
obfuscateContactById 1 param → 202401403404409429
DELETE
/contacts/{id}/profile-images
Delete Contact Profile Picture
deleteContactProfileImage 1 param → 204401403404429
PUT
/contacts/{id}/profile-images
Assign Contact Profile Picture
assignContactProfileImage 1 param body → 200400401403404429
GET
/contacts/{id}/related-contacts
Get Related Contact Ids
getContactRelationshipsById 3 params → 200400401403404429
PUT
/contacts/{id}/related-contacts/{relatedContactId}
Add Contact Relationship
createContactRelationship 2 params → 204400401403404429
DELETE
/contacts/{id}/related-contacts/{relatedContactId}
Delete Contact Relationship
deleteContactRelationship 2 params → 204401403404429

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are Contact (39 properties), contact-group (7 properties), ContactMembership (7 properties), ContactHistory (6 properties). Each schema is shown below with its type and property counts.

contact-bulk-response
array
List of contacts to create or update.
custom-field
object
A Custom Field
1 property
ContactMembership
object
Contact Membership information
7 properties
CustomFieldType
string
The type of data collected by a custom field.
AttendeeContactType
object
Contains details related to the attendee's contact type.
2 properties
DistributionListInfo
object
Model representing a distribution list info. Only required if the contact group type is DISTRIBUTIONLIST.
3 properties
contact-group
object
A group of contacts.
7 properties 2 required
Gender
string
The gender of the contact.
IdOnlyEntity
object
An entity which only has an id.
1 property 1 required
ContactGroupType
string
Type of contact group. BLACKLIST are contacts that are not allowed to register for your events. DISTRIBUTIONLIST is a group of contacts you plan to send eMarke…
contact-merge
object
This entity represents a request to merge one or two contacts with another 'main' contact.
2 properties 1 required
BaseAddress
object
Base Address Model
6 properties
contact
object
Represents a contact that has been created and has an id.
3 properties
UpdatedThroughNameProperty
string
Name of the place where this change was updated through.
ContactId
object
A contact id.
1 property 1 required
Compliance
object
Privacy compliance fields for a contact.
4 properties
ContactOptOut
object
Details of an opt-out for a Contact.
3 properties
contact-update
This entity is used to represent a single item that is requested for a contact update
1 required
ErrorResponse
object
Represents an error response with additional details of cascading error messages.
1 property 2 required
uuid-property
string
A string that has to be a format matching the industry standard uuid
DistributionListStatus
string
Type of distribution list status.
contact-type-paginated-response
object
The response from a request to get the list of contact types. This includes the paging object as well as the collection of contact-types.
2 properties 2 required
AddressType
string
The type of address.
ContactMergeField
object
A pair of a contact field name and a contact id.
2 properties 2 required
DistributionListSecurityType
string
Type of distribution list security. For a public list, contacts can sign up themselves. For a semi-private list, contacts can add themselves, but a planner mus…
contact-bulk-patch
array
contact-paginated-response
object
The response from a request to get the list of contacts. This includes the paging object as well as the collection of contacts.
2 properties 2 required
ContactBulkResponseItem
object
This entity is used to represent a single item that is returned as part of a Bulk request call.
1 property
ContactType
object
This entity represents a contact type at contact level.
5 properties 3 required
CustomFieldBase
object
Base schema for Custom Field - allows type to be customized by extending schemas
4 properties 2 required
contact-group-paginated-response
object
The response from a request to get the list of contact groups. This includes the paging object as well as the collection of contact-groups.
2 properties 2 required
Address
object
Contact address details.
3 properties
Passport
object
This entity represents a contact's passport information.
3 properties
BulkResponseItem
object
Represents a single item that is returned as part of a Bulk request call.
4 properties 2 required
ContactLinks
object
Collection of social media links for the contact.
4 properties
contact-id-paginated-response
object
The response from a request to get the ids of contacts in a contact group or relationship. This includes the paging object as well as the collection of contact…
2 properties 2 required
Paging
object
Represents pagination information for a collection of resources.
6 properties 1 required
Link
object
Represents a link to a related resource.
1 property 1 required
contact-history-paginated-response
object
The response of a request to get the change history for a specific contact.
2 properties
CreateContact
object
Represents a contact to be created.
2 properties
Audit
object
Audit information
4 properties
Contact
object
Represents a contact and their related information.
39 properties
SurveyContactId
object
A pair of survey and contact id.
2 properties 2 required
ContactCreate
This entity is used to represent a single item that is posted for a contact create
ErrorResponseBase
object
Represents an error response with no additional details.
3 properties 2 required
ContactHistory
object
A single instance of change for a specific contact in the contact's change history.
6 properties
PaginationLinks
object
Represents pagination links for navigating between pages of data.
3 properties
contact-bulk-create
array
contact-bulk-update
array
contact-file
object
A contact's file, such as a profile image.
2 properties 2 required
contact-patch
This entity is used to represent a single item that is requested for a contact patch.
1 required
OptoutBy
string
This is used to denote how a contact is opt'd out of Cvent system.
contact-obfuscation-status
object
Model representing an obfuscation status of a contact.
3 properties
EventContactId
object
A pair of event and contact id.
2 properties 2 required
filter
object
A filter which is sent through the body of the request.
1 property
ContactObfuscationStatusType
string
Status of the request to obfuscate a contact. INITIATED - The obfuscation request has been received. QUEUED - The obfuscation request is currently waiting in t…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cvent-event-cloud-contacts-api-openapi.yml Raw ↑

Other APIs Cvent Event Cloud publishes across the network.

Cvent Platform REST API (Event Cloud)
Cvent Event Cloud Attendees API
Cvent Event Cloud Events API
Cvent Event Cloud Sessions API
Cvent Event Cloud Appointments API
Cvent Event Cloud Attendee Activities API
Cvent Event Cloud Attendee Insights API
Cvent Event Cloud Attendee Messages API
Cvent Event Cloud Audience Segments API
Cvent Event Cloud Authentication API
Cvent Event Cloud Badge Print Job API
Cvent Event Cloud Badge Printer Pools API
Where this information came from

This is an independent, third-party profile of Cvent Event Cloud Contacts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.