openapi: 3.2.0
info:
title: Cvent REST APIs — Event Cloud Events+ Hub API
description: "Event Cloud scope of the Cvent REST APIs. This document is a TAG-SCOPED SUBSET of the OpenAPI specification Cvent publishes at https://github.com/cvent/rest-sdks/blob/main/cvent-public-spec/openapi.yaml (the source of truth for Cvent's official TypeScript/.NET/Java SDKs). Venue-sourcing, RFP, housing-supplier and travel-supplier tags were removed because they belong to Cvent Hospitality Cloud; every path, operation, parameter, schema and security requirement below is verbatim from Cvent's published spec.\n\n# Introduction\nThe Cvent API Platform is built around REST. We aim to provide intuitive endpoints that can be easily\ndiscovered to help leverage the Cvent platform for your event needs. The RESTful APIs outlined here\nuse JSON-encoded request and response format, along with HTTP codes, to convey processing status of\nrequests received. The Cvent resources are protected using OAuth2.\n\n# Getting Started\n\nIf you're new to the Cvent API Platform, start by reading our\n[Developer Quickstart](https://developers.cvent.com/docs/rest-api/tutorials/developer-quickstart) guide. This will\ngive you an overview of how to authenticate and make requests using our APIs.\n\n## Authentication\n\nThe Cvent REST API uses [OAuth2](https://oauth.net/2/) to authorize requests to the platform. The client\ncredentials authorization flow is supported.\n\n<a name=\"oauth2-auth-code-planner-admin\"></a>\n\nAuthorization code flow is only supported for planner users with the administrator role in Cvent. Developer users\ncannot use authorization code flow.\n\n<!-- ReDoc-Inject: <security-definitions> -->\n\nHere's an example of using client credential flow to authorize. You'll supply your application's id and secret to\nmake a [Token](#operation/oauth2Token) request.\n\n```bash\ncurl --location --request POST '{hostName}/{version}/oauth2/token' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--header 'Authorization: Basic {api_credentials}' \\\n--data-urlencode 'grant_type=client_credentials' \\\n--data-urlencode 'client_id={client_id}'\n```\n\n| Key | Description | Value |\n| :---------------- | :--------------------------------------------------- | :----------------------------------------------------------------------------------------------------------- |\n| {hostName} | https://api-platform.cvent.com | Location if your account is in the North American datacenter. |\n| | https://api-platform-eur.cvent.com | Location if your account is in the European data center. |\n| {version} | ea | The version of the API you're using. Only `ea` is currently supported. |\n| {api_credentials} | {client_id}:{client_secret} in base64 encoded format | Supply your client id & client credentials in a base 64 encoded format. |\n| {client_id} | Retrieved from your application | Your application's client id. |\n| {client_secret} | Retrieved from your application | Your application's client secret. |\n\nOn a successful call, you'll receive the following response:\n\n```json\n{\n \"access_token\": \"{accessToken}\",\n \"expires_in\": 3600,\n \"token_type\": \"Bearer\"\n}\n```\n\nThis bearer token is valid for 3600 seconds (60 minutes) and must be used in subsequent calls.\n\n## Endpoints\n\nEndpoints start with `hostName` and `version`.\n\nThe `hostname` will depend on the region that your Cvent account is hosted in. Please see the table\nbelow to identify which hostname you should be using.\n\n| Region |\tHostname |\n|:--------------|:-----------------------------------|\n| North America\t| https://api-platform.cvent.com |\n| Europe | https://api-platform-eur.cvent.com |\n\nThe current `version` of the Cvent API is `ea`.\n\n## Rate Limits\n\nCvent APIs enforce rate limits to ensure platform stability. Your limits depend on your tier: Free,\nStandard, or Premium.\n\n<br />\n\n### Usage Tiers\n\n| Tier | Daily Calls | Calls per Second | Max Burst |\n| -------- | ----------- | ---------------- | --------- |\n| Free | 1,000 | 2 | 1 |\n| Standard | 15,000 | 10 | 10 |\n| Premium | 500,000 | 25 | 25 |\n\n- **Daily calls** define how many requests you can make in a 24-hour period. Quota\n resets at 12 midnight (+0 GMT).\n- **Calls per second** define how many requests you can make in a 1-second window.\n- **Max Burst** defines how many requests you can make at once.\n\nIf you are unsure what usage tier applies to your account, you can check via\n[Get Current Usage Tier](#operation/getUsageTier).\n\nPlease note that these limits may change as the Cvent API Platform evolves.\n\n<br />\n\n### Handling Rate Limits\n\nSometimes, you may exceed your rate limits. When this happens, the API will return a `429 Too Many Requests`. See\n[handling rate limits](https://developers.cvent.com/docs/rest-api/guides/handling-rate-limits) for best practices on how to handle this.\n\n## Pagination\n\nSome APIs use pagination to manage records. Each page of records has a token associated to identify it.\n\nIf an API uses pagination, you’ll find up to three tokens in the response:\n- **currentToken**: Describes the token of the current page.\n- **nextToken**: Provides a token for the next page of records, if one exists.\n- **previousToken**: Provides a token for the previous page of records, if one exists. Not all APIs will return\n this token.\n\nYou specify which page of records to view via the `token` parameter in your API call. To navigate through pages,\ntake the `nextToken` or `previousToken` value and pass it to your next call’s `token` parameter to get the\nrespective page of records. For example, if you made this request:\n\n```bash\ncurl -X GET {hostname}/{version}/contacts?limit=100 \\\n-H 'Accept: application/json' \\\n-H 'Authorization: Bearer {accessToken}'\n```\n\nThe response contains a paging array where you'll find the token information.\n\n```json\n{\n \"paging\": {\n \"currentToken\": \"90c5f062-76ad-4ea4-aa53-00eb698d9262\",\n \"nextToken\": \"3b2359a7-4583-40ed-8afd-67e5f15373d3\",\n \"limit\": 100,\n \"totalCount\": 102,\n \"_links\": {...}\n },\n \"data\": [...]\n}\n```\n\nTake the `nextToken` and use it in the `token` parameter on your subsequent call.\n\n```bash\ncurl -X GET {hostname}/{version}/contacts?limit=100&token=3b2359a7-4583-40ed-8afd-67e5f15373d3 \\\n-H 'Accept: application/json' \\\n-H 'Authorization: Bearer {accessToken}'\n```\n\nWhen the response doesn’t contain a `nextToken` field, you’ve reached the last page. Occasionally, you might\nencounter an empty page at the end of results. This typically happens when the results were evenly divisible.\nEnsure your client code handles the possibility of receiving an empty data array when using the `nextToken`.\n\n## Filtering\n\nUse filters to narrow down results. The filter follows the pattern\n`filter='field' comparisonType 'value'`. The value can be enclosed with single\nquotes (') or double quotes (\").\n\n```bash\nGET {hostName}/{version}/contacts?filter=lastName eq 'Smith'\n````\n\nTo correctly pass a single quote in the filter's value, use double quotes around\nthe string.\n\n```bash\nGET {hostName}/{version}/contacts?filter=lastName eq \"O'Keenan\"\n```\n\nTo correctly pass a double quote in the filter's value, use double quotes around\nthe string and add an escape character `\\` to each quote that is part of the\nstring.\n\n```bash\nGET {hostName}/{version}/events?filter=eventName eq \"\\\"Yearly\\\" Conference\"\n```\n\n## Versioning\n\nChange is inevitable in API development. Planning for it is crucial. We track\nboth backward-compatible and backward-incompatible changes.\n\n<br />\n\n### Backward Compatible Changes\n\nBackward compatible changes will be made often and are intended to avoid\nany adverse impact on our customers. It is highly advisable that when reading\nJSON payloads from Cvent, you are able to handle \"unknown\" attributes that\ncan be added over time. We consider the following changes backward-compatible:\n\n- Adding new resources\n- Adding new optional request parameters to existing operations\n- Adding new attributes to requests or responses\n- Changing the length or format (not type) of resource identifiers. For example, an ID can change from\n \"1234/1234\" to \"1234::1234\".\n- Increasing the length of string fields\n\n<br />\n\n### Backward Incompatible Changes\n\nBackward-incompatible changes are made infrequently, however, they can be\ndisruptive to consumers. Due to this, our APIs are versioned to avoid\ndisruptions to customers. We leverage a URI-based versioning scheme,\nwhich means that a version value is included in the Cvent API URL.\nWhen breaking changes occur, a new version of the API is made available\nwhile the existing version is deprecated but remains available for a\nlimited period of time. We consider the following backward-incompatible changes:\n\n- Adding a new required parameter (query string param or payload attribute)\n- Deleting API resources\n- Deleting any attribute from API responses\n- Changing the data type on any parameter or attribute\n\n## Standards\nAs you begin working with our APIs, it's essential to be aware of standards around\ncountry codes, time formats, and other important details that ensure smooth integration.\nLearn more about our [API Standards](https://developers.cvent.com/docs/rest-api/reference/api-standards)\n"
contact:
name: Cvent Development Platform
url: https://developers.cvent.com/
version: ea
servers:
- url: https://api-platform.cvent.com/ea
- url: https://api-platform-eur.cvent.com/ea
tags:
- name: Events+ Hub
description: An Events+ Hub persists basic information needed to assign an owner and optionally customize the public presentation.
paths:
/hubs:
get:
summary: List Events+ Hubs
description: Get a paginated list of all Events+ hubs associated with your account. Each Events+ hub returned contains owner and theme information as well as the current status.
operationId: listHubs
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
- $ref: '#/components/parameters/videoHubFilter'
tags:
- Events+ Hub
security:
- OAuth2.authorizationCode:
- events-plus/hubs:read
- OAuth2.clientCredentials:
- events-plus/hubs:read
responses:
'200':
description: Successfully retrieved a paginated list of Events+ hubs and their related details.
content:
application/json:
schema:
$ref: '#/components/schemas/hubs-paginated-response'
'400':
$ref: '#/components/responses/BadRequest1'
'401':
$ref: '#/components/responses/Unauthorized1'
'403':
$ref: '#/components/responses/Forbidden1'
'429':
$ref: '#/components/responses/TooManyRequests1'
/hubs/{hubId}/members:
get:
tags:
- Events+ Hub
security:
- OAuth2.authorizationCode:
- events-plus/hubs:read
- OAuth2.clientCredentials:
- events-plus/hubs:read
summary: Get Events+ Hub Members
operationId: getHubMembers
description: Fetches a list of members associated with a particular Events+ hub.
parameters:
- $ref: '#/components/parameters/hubId'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
- $ref: '#/components/parameters/memberFilter'
- $ref: '#/components/parameters/memberListSort'
responses:
'200':
description: Members fetched successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/paginated-existing-member'
'400':
$ref: '#/components/responses/BadRequest1'
'401':
$ref: '#/components/responses/Unauthorized1'
'403':
$ref: '#/components/responses/Forbidden1'
'404':
$ref: '#/components/responses/NotFound1'
'429':
$ref: '#/components/responses/TooManyRequests1'
components:
schemas:
UUIDProperty:
title: UUID Property
description: A string that has to be a format matching the industry standard uuid
type: string
format: uuid
example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
WorkAddress:
title: WorkAddress
type: object
description: Member's work address details.
properties:
city:
type: string
maxLength: 50
example: New York
description: Member's work address city.
state:
type: string
maxLength: 50
example: New York
description: Member's Work address state.
country:
type: string
maxLength: 100
example: USA
description: Member's work address country.
HubLogin:
title: HubLogin
type: object
properties:
type:
type: string
default: MAGIC_LINK
enum:
- MAGIC_LINK
- SSO
- BOTH
description: 'Login method for the members of the Events+ hub. MAGIC_LINK: The members can log in via a ''magic link'' provided via email. Magic links are unique for each member, allowing the member to log in without requiring credentials. SSO: The members log in via a single-sign-on (SSO) method previously configured in the Events+ hub. BOTH: Members can log in via the magic link method or the single-sign-on (SSO) method.'
organizationId:
type: string
description: Organization identifier of a Cvent identity provider when SSO login type is selected. This value is provided by Cvent when an account is first configured to support SSO. To read more about Cvent SSO support, see https://developers.cvent.com/docs/sso/overview.
example: OneloginforFlexGuestside
maxLength: 255
idpUrl:
type: string
format: uri
description: The service provider-initiated URL, used by Events+ hub members for single sign-on (SSO). Used when the `type` property is SSO or BOTH.
example: https://login.cvent.com/redirect?redirectUrl=https://cvent-login.com/oauth2/oauth-redirect&productId=0oaztigu7sVcS4PHM0h7&identityProviderName=OneloginforFlexGuestside
description: Fields relating to the login process for the Events+ hub.
Audit:
title: Audit
description: Audit information
type: object
properties:
created:
type: string
format: date-time
description: The ISO 8601 zoned date time when this record was created.
readOnly: true
example: '2017-01-02T02:00:00Z'
createdBy:
type: string
description: The identifier of the user that created this record.
readOnly: true
example: hporter
lastModified:
type: string
format: date-time
description: The ISO 8601 zoned date time when this record was updated.
readOnly: true
example: '2019-02-12T03:00:00Z'
lastModifiedBy:
type: string
description: The identifier of the user that last updated this record.
readOnly: true
example: hporter
paginated-existing-member:
title: Paginated Existing Member
description: A paginated list of Events+ members.
required:
- paging
- data
type: object
properties:
paging:
$ref: '#/components/schemas/Paging'
data:
type: array
items:
$ref: '#/components/schemas/ExistingMember'
description: Collection of Events+ members.
ExistingMember:
title: Existing Member
description: An existing member.
type: object
allOf:
- $ref: '#/components/schemas/member-profile'
properties:
id:
type: string
description: The unique ID of the member.
example: c764fb48-a62b-4c5f-b98f-01b5dae2c2ff
format: uuid
PaginationLinks:
title: PaginationLinks
type: object
description: Represents pagination links for navigating between pages of data.
properties:
next:
$ref: '#/components/schemas/Link'
self:
$ref: '#/components/schemas/Link'
prev:
$ref: '#/components/schemas/Link'
HubOwner:
title: HubOwner
type: object
description: The owner of the Events+ hub and their information.
properties:
firstName:
type: string
description: First name of the Events+ hub owner.
example: Achuthanandan
maxLength: 255
minLength: 1
lastName:
type: string
description: Last name of the Events+ hub owner.
example: Velikkakathu Sankaran
maxLength: 255
minLength: 1
email:
type: string
format: email
description: Email address of the Events+ hub owner.
example: owner@example.com
maxLength: 255
minLength: 1
HubIdPropertyReadOnly:
title: HubIdPropertyReadOnly
description: The unique ID of an Events+ Hub.
type: string
format: uuid
example: 1e7e0f38-d73c-4326-9f93-422086b91304
readOnly: true
ErrorResponseBase:
title: ErrorResponseBase
type: object
description: Represents an error response with no additional details.
required:
- code
- message
properties:
code:
type: integer
description: The HTTP status code representing the error.
example: 400
message:
type: string
description: A brief description of the error.
example: Bad Request
target:
type: string
description: The target resource of the error.
example: example target
ErrorResponse:
title: ErrorResponse
description: Represents an error response with additional details of cascading error messages.
allOf:
- $ref: '#/components/schemas/ErrorResponseBase'
type: object
required:
- code
- message
properties:
details:
type: array
items:
$ref: '#/components/schemas/ErrorResponseBase'
description: Additional details of cascading error messages.
hubs-paginated-response:
title: HubsPaginatedResponse
description: The response from a request to get the list of Events+ hubs. This includes the paging object as well as the collection of Events+ hubs.
required:
- paging
- data
type: object
properties:
paging:
$ref: '#/components/schemas/Paging'
data:
type: array
maxItems: 200
items:
$ref: '#/components/schemas/existing-hub'
description: List of Events+ hubs.
SocialMediaLinks:
title: SocialMediaLinks
type: object
description: Member's social media links.
properties:
facebookUrl:
$ref: '#/components/schemas/Link'
twitterUrl:
$ref: '#/components/schemas/Link'
linkedinUrl:
$ref: '#/components/schemas/Link'
websiteUrl:
$ref: '#/components/schemas/Link'
UTMOverride:
title: UTMOverride
description: 'Specifies how UTM (urchin tracking module: a key and value that is attached to URLs for the purpose of identifying and tracking traffic) settings will override passed in items.'
type: string
enum:
- use-existing-parameter
- use-custom-parameter
default: use-existing-parameter
example: use-custom-parameter
HubBackground:
title: HubBackground
type: object
description: The background image of the Events+ hub.
properties:
url:
description: The optimized URL of the Events+ hub's background image. The background image appears on the Events+ hub registration page.
type: string
format: uri
example: https://images.cvent.com/ab5d5f790f6b4a90b29a3711d4ec381f/video-center/4833fde2-eedf-4751-92a5-f788cfa70674/43c5b520abf9635f4168a2ce37a89d89!_!6fbef1a131b81d4bed2b16c175ef57cd.jpeg
originalUrl:
description: The original URL of the Events+ hub background image. The background appears on the Events+ hub Registration page.
type: string
format: uri
example: https://custom.cvent.com/ab5d5f790f6b4a90b29a3711d4ec381f/video-center/4833fde2-eedf-4751-92a5-f788cfa70674/43c5b520abf9635f4168a2ce37a89d89.jpeg
altText:
type: string
description: Alternate text for the background image.
example: A mostly empty conference room.
minLength: 1
maxLength: 100
Link:
title: Link
required:
- href
type: object
description: Represents a link to a related resource.
properties:
href:
type: string
description: A url provided that can be followed for linking
example: ?token=90c5f062-76ad-4ea4-aa53-00eb698d9262
HubCalendar:
title: HubCalendar
type: object
description: The event calendar associated with this Events+ hub. The event calendar allows you to share multiple events and sessions in a list or calendar format.
properties:
id:
description: The ID of the calendar associated to an Events+ hub.
type: string
format: uuid
example: 1e7e0f38-d73c-4326-9f93-422086b91304
maxLength: 255
layout:
description: The initial layout style used by front-ends to render the associated calendar.
type: string
enum:
- List
- Grid
example: List
member-profile:
title: MemberProfile
type: object
description: Events+ member profile details.
required:
- firstName
- lastName
properties:
firstName:
type: string
description: Member's first name.
example: Mateo
maxLength: 30
lastName:
type: string
description: Member's last name
example: Allende
maxLength: 30
prefix:
type: string
description: Used to denote title of member e.g. Mr., Mrs., Dr. etc.
example: Dr.
maxLength: 30
designation:
type: string
description: Member's designation in the company.
maxLength: 30
example: White Wolf
jobTitle:
type: string
description: Member's job title.
maxLength: 100
example: Director
companyName:
type: string
description: Member's company name.
maxLength: 100
example: Cvent.inc
headline:
type: string
description: Member's biographical writeup.
example: A visionary in the field of event planning.
maxLength: 220
pronouns:
type: string
description: Member's pronouns.
maxLength: 30
example: she/her
socialMediaLinks:
$ref: '#/components/schemas/SocialMediaLinks'
profileImageUrl:
title: Link
required:
- href
type: object
description: The optimized URL of the Events+ member's profile image.
properties:
href:
type: string
description: A URL pointing to the member's profile image.
example: ?token=90c5f062-76ad-4ea4-aa53-00eb698d9262
emailAddress:
type: string
description: Member's email address.
maxLength: 80
example: abc@example.com
mobileNumber:
type: string
maxLength: 30
example: 555-555-5555
description: Member's mobile number.
workAddress:
$ref: '#/components/schemas/WorkAddress'
compliance:
$ref: '#/components/schemas/Compliance'
locale:
type: string
description: Member's preferred language. Used for localization of the UI and emails. The value should be in the form of an ISO-639 language code and ISO 3166-1 Alpha-2 country code separated by a hyphen. e.g. en-US, fr-FR, es-ES etc.
example: en-US
registrationDate:
type: string
format: date-time
description: The ISO 8601 zoned date time when the member registered.
example: '2017-01-02T02:00:00Z'
readOnly: true
lastLoginDate:
type: string
format: date-time
description: The ISO 8601 zoned date time when the member last logged in.
readOnly: true
example: '2017-01-02T02:00:00Z'
visible:
type: boolean
default: false
description: True indicates member profile is visible to other members.
HubLogo:
title: HubLogo
type: object
description: The logo for the Events+ hub.
properties:
url:
description: The optimized Events+ hub logo image URL.
type: string
format: uri
example: https://images.cvent.com/ab5d5f790f6b4a90b29a3711d4ec381f/video-center/4833fde2-eedf-4751-92a5-f788cfa70674/43c5b520abf9635f4168a2ce37a89d89!_!6fbef1a131b81d4bed2b16c175ef57cd.jpeg
originalUrl:
description: The original URL of the logo image that was uploaded to the Events+ hub. Supported file types are JPEG, JPG, PNG, GIF. Recommended logo size is 170 x 90 pixels and 72 PPI.
type: string
format: uri
example: https://custom.cvent.com/ab5d5f790f6b4a90b29a3711d4ec381f/video-center/4833fde2-eedf-4751-92a5-f788cfa70674/43c5b520abf9635f4168a2ce37a89d89.jpeg
altText:
type: string
description: Alternate text for the logo image.
example: A mostly empty conference room.
minLength: 1
maxLength: 100
HubStatusProperty:
title: HubStatusProperty
type: string
enum:
- Inactive
- Active
- Deleted
description: 'The current Events+ Hub status. Inactive: The Events+ Hub is inactive and unavailable to members. Active: Members can access the Events+ Hub. Deleted: The Events+ Hub has been deleted and is unavailable to members or planners.'
HubColors:
title: HubColors
type: object
description: All the colors associated with the Events+ hub.
properties:
action:
title: Action Color
description: The secondary color of an Events+ hub.
type: string
example: '#0F0F0F'
pattern: ^#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})$
maxLength: 7
background:
title: Background Color
description: The background color of an Events+ hub.
type: string
example: '#0F0F0F'
pattern: ^#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})$
maxLength: 7
main:
title: Main Color
description: The primary color of an Events+ hub.
type: string
example: '#0F0F0F'
pattern: ^#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})$
maxLength: 7
mood:
title: Mood Color
description: An Events+ hub color configuration that can be set to light, dark, or a similar shade to the main color.
type: string
example: '#0F0F0F'
pattern: ^#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})$
default: '#FFFFFF'
maxLength: 7
HubFonts:
title: HubFonts
type: object
description: The fonts of the Events+ hub.
properties:
headingId:
type: string
format: uuid
example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
description: The id of the font used in this Events+ hub's heading. Custom fonts are previously uploaded in the account.
bodyId:
type: string
format: uuid
example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
description: The id of the font used in this Events+ hub's body text. Custom fonts are previously uploaded in account.
Compliance:
title: Compliance
description: Privacy compliance fields for a contact.
type: object
properties:
creationTime:
type: string
format: date-time
description: Date-time (in GMT) when privacy compliance details were created for the contact.
example: '2021-03-08T17:30:01.727Z'
complianceScope:
type: string
description: Scope of privacy compliance.
example: CCPA
enum:
- CCPA
action:
type: string
description: Action to take for a compliance request.
example: DO_NOT_SELL
enum:
- DO_NOT_SELL
- OK_TO_SELL
createdBy:
type: string
description: Denotes how the compliance request was created.
example: PLANNER
enum:
- ATTENDEE
- PLANNER
- IMPORT
- SOAP_API
- REST_API
- MARKETO
- SALEFORCE
- VIDEO_CENTER_MEMBER
- RESPONDENT
- NOT_SET
Paging:
title: Paging
required:
- _links
type: object
description: Represents pagination information for a collection of resources.
properties:
previousToken:
type: string
description: The pagination token for the previous page, if one exists. You can use this token to navigate to the previous page of data.
example: 1a2b3c4d5e6f7g8h9i10j11k
nextToken:
type: string
description: The pagination token for the next page. If this value is present in the response, there is another page of data you can fetch.
example: 1a2b3c4d5e6f7g8h9i10j11k
currentToken:
type: string
description: The pagination token for the current page.
example: 1a2b3c4d5e6f7g8h9i10j11k
limit:
type: integer
description: The number of records to return on the page. Not to exceed 200.
example: 100
totalCount:
type: integer
description: The total number of records available. This field may return blank, even if there are more records. To confirm if there are more records, check the `nextToken` field.
example: 2
_links:
$ref: '#/components/schemas/PaginationLinks'
Hub:
title: Hub
type: object
description: An Events+ hub consists of basic information and theme data such as title, owner*Name, url, backgroundColor and logoImage.
required:
- title
- owner
allOf:
- $ref: '#/components/schemas/Audit'
properties:
title:
type: string
description: A short descriptor of the Events+ hub.
example: Future Technologies
maxLength: 255
minLength: 1
owner:
$ref: '#/components/schemas/HubOwner'
customDomain:
type: string
description: Custom domain name of the Events+ hub.
example: example.com
maxLength: 255
url:
title: Events+ Hub URL
description: The URL that links to the Events+ hub.
type: string
format: uri
pattern: ^https:\/\/[\S]{2,}
example: https://web.cvent.com/eventsplus
maxLength: 255
colors:
$ref: '#/components/schemas/HubColors'
themeSafeMode:
type: boolean
description: True
# --- truncated at 32 KB (76 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cvent-event-cloud/refs/heads/main/openapi/cvent-event-cloud-events-hub-api-openapi.yml