openapi: 3.2.0
info:
title: Cvent REST APIs — Event Cloud Exhibitor Team 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: Exhibitor Team
description: '* **Exhibitor Admin -** Exhibitor Admins are administrators that have access to the exhibitor portal. In the portal, they are able to complete pre-event tasks, manage their team, purchase LeadCapture (if applicable), and download leads. Use this API to get details for existing admins, create new admins, and update admin details.
* **Exhibitor Booth Staff -** Exhibitor booth staff is someone that manages the frontline of the exhibitor''s booth onsite or virtually. Booth staff needs to be registered for the event in order to be associated with an exhibitor. Use this API to get details for the existing booth staff(s) for a specific exhibitor, associate new booth staff to the exhibitor, and delete the association of a booth staff if required.
'
paths:
/events/{id}/exhibitors/{exhibitorId}/admins:
get:
summary: List Exhibitor Admins
description: Retrieves a paginated list of exhibitor admins for an exhibitor within an event.
operationId: listExhibitorAdmins
tags:
- Exhibitor Team
security:
- OAuth2.clientCredentials:
- exhibitor/exhibitor-admins:read
- OAuth2.authorizationCode:
- exhibitor/exhibitor-admins:read
parameters:
- $ref: '#/components/parameters/id6'
- $ref: '#/components/parameters/exhibitorId'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
responses:
'200':
description: Successfully retrieved exhibitor admins.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/exhibitor-admins-list-response'
'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'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
post:
summary: Create Exhibitor Admin
description: Creates an exhibitor admin for the given exhibitor.
operationId: postExhibitorAdmin
tags:
- Exhibitor Team
security:
- OAuth2.clientCredentials:
- exhibitor/exhibitor-admins:write
- OAuth2.authorizationCode:
- exhibitor/exhibitor-admins:write
parameters:
- $ref: '#/components/parameters/id6'
- $ref: '#/components/parameters/exhibitorId'
requestBody:
description: Exhibitor Admin details
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/exhibitor-admin-request'
responses:
'201':
description: Successfully created an Exhibitor Admin.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/exhibitor-admin-response'
'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'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/events/{id}/exhibitors/{exhibitorId}/admins/{adminId}:
get:
summary: Get Exhibitor Admin
description: Gets the details of a single exhibitor admin, such as name or contact email.
operationId: getExhibitorAdmin
tags:
- Exhibitor Team
security:
- OAuth2.clientCredentials:
- exhibitor/exhibitor-admins:read
- OAuth2.authorizationCode:
- exhibitor/exhibitor-admins:read
parameters:
- $ref: '#/components/parameters/id6'
- $ref: '#/components/parameters/exhibitorId'
- $ref: '#/components/parameters/adminId'
responses:
'200':
description: Successfully retrieved details for an exhibitor admin.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/exhibitor-admin-response'
'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'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
put:
summary: Update Exhibitor Admin
description: Updates a single exhibitor admin.
operationId: updateExhibitorAdmin
tags:
- Exhibitor Team
security:
- OAuth2.clientCredentials:
- exhibitor/exhibitor-admins:write
- OAuth2.authorizationCode:
- exhibitor/exhibitor-admins:write
parameters:
- $ref: '#/components/parameters/id6'
- $ref: '#/components/parameters/exhibitorId'
- $ref: '#/components/parameters/adminId'
requestBody:
description: Exhibitor Admin details
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/exhibitor-admin-request'
responses:
'200':
description: Successfully updated the Exhibitor Admin.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/exhibitor-admin-response'
'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'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/events/{id}/exhibitors/{exhibitorId}/booth-staff:
get:
summary: List Booth Staff
description: Gets a list of booth staff members for a given event and exhibitor id.
operationId: listBoothStaff
tags:
- Exhibitor Team
security:
- OAuth2.clientCredentials:
- exhibitor/booth-staff:read
- OAuth2.authorizationCode:
- exhibitor/booth-staff:read
parameters:
- $ref: '#/components/parameters/id6'
- $ref: '#/components/parameters/exhibitorId'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
responses:
'200':
description: Successfully retrieved booth staff list.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/booth-staff-list-response'
'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'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
post:
summary: Create Booth Staff
description: Associates a registered attendee as a booth staff to a specific exhibitor id within an event.
operationId: associateBoothStaff
tags:
- Exhibitor Team
security:
- OAuth2.clientCredentials:
- exhibitor/booth-staff:write
- OAuth2.authorizationCode:
- exhibitor/booth-staff:write
parameters:
- $ref: '#/components/parameters/id6'
- $ref: '#/components/parameters/exhibitorId'
requestBody:
description: Booth Staff details
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/booth-staff-request'
responses:
'201':
description: Successfully associated booth staff
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/booth-staff-response'
'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'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/events/{id}/exhibitors/{exhibitorId}/booth-staff/{boothstaffId}:
get:
summary: Get Booth Staff member
description: Retrieves the attendee id associated with an exhibitor booth staff member.
operationId: getBoothStaff
tags:
- Exhibitor Team
security:
- OAuth2.clientCredentials:
- exhibitor/booth-staff:read
- OAuth2.authorizationCode:
- exhibitor/booth-staff:read
parameters:
- $ref: '#/components/parameters/id6'
- $ref: '#/components/parameters/exhibitorId'
- $ref: '#/components/parameters/boothstaffId'
responses:
'200':
description: Successfully retrieved details for a booth staff member.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/booth-staff-response'
'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'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
delete:
summary: Delete Booth Staff member
description: Disassociate a single booth staff member from a single exhibitor.
operationId: deleteBoothStaff
tags:
- Exhibitor Team
security:
- OAuth2.clientCredentials:
- exhibitor/booth-staff:delete
- OAuth2.authorizationCode:
- exhibitor/booth-staff:delete
parameters:
- $ref: '#/components/parameters/id6'
- $ref: '#/components/parameters/exhibitorId'
- $ref: '#/components/parameters/boothstaffId'
responses:
'204':
description: Successfully deleted booth staff member.
headers: {}
'401':
$ref: '#/components/responses/Unauthorized1'
'403':
$ref: '#/components/responses/Forbidden1'
'404':
$ref: '#/components/responses/NotFound1'
'429':
$ref: '#/components/responses/TooManyRequests1'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
components:
schemas:
Event3:
description: The Associated Event.
title: Event
type: object
required:
- id
properties:
id:
type: string
format: uuid
example: 3db28cfc-db22-11eb-8d19-0242ac130003
description: Event id
exhibitor-admins-list-response:
title: ExhibitorAdminsListResponse
type: object
description: Exhibitor Admins List Response schema
properties:
paging:
$ref: '#/components/schemas/Paging'
data:
type: array
items:
$ref: '#/components/schemas/exhibitor-admin-response'
description: List of exhibitor admins.
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
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'
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.
booth-staff-request:
title: Booth Staff
description: A JSON schema representing booth staff.
required:
- attendee
- event
- exhibitor
type: object
allOf:
- $ref: '#/components/schemas/Audit'
properties:
attendee:
$ref: '#/components/schemas/Attendee1'
event:
$ref: '#/components/schemas/Event3'
exhibitor:
$ref: '#/components/schemas/Exhibitor'
Exhibitor:
description: The Associated Exhibitor.
title: Exhibitor
type: object
required:
- id
properties:
id:
type: string
format: uuid
example: 4888db54-db22-11eb-8d19-0242ac130003
description: Exhibitor id
exhibitor-admin-request:
title: Exhibitor Admin
type: object
description: An object representing the exhibitor admin.
allOf:
- $ref: '#/components/schemas/OSSAudit'
required:
- exhibitor
- email
- firstName
- lastName
properties:
exhibitor:
$ref: '#/components/schemas/Exhibitor'
firstName:
type: string
description: The first name of the exhibitor admin
minLength: 1
maxLength: 30
example: John
lastName:
type: string
description: The last name of the exhibitor admin
minLength: 1
maxLength: 30
example: Eddy
email:
type: string
format: email
description: The email address of the exhibitor admin
example: john.eddy@test.com
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
booth-staff-list-response:
title: BoothStaffListResponse
type: object
description: Represents the booth staff list response, with paging information and a list of booth staff.
properties:
paging:
$ref: '#/components/schemas/Paging'
data:
type: array
items:
$ref: '#/components/schemas/booth-staff-response'
description: List of booth staff.
exhibitor-admin-response:
title: Exhibitor Admin
type: object
allOf:
- $ref: '#/components/schemas/exhibitor-admin-request'
properties:
id:
type: string
format: uuid
example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
description: Exhibitor Admin id
readOnly: true
description: Existing Exhibitor Admin with an id property
OSSAudit:
title: OSS-Audit
description: OSS 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.This filed is deprecated.
deprecated: true
readOnly: true
example: hporter
Attendee1:
description: The associated Attendee.
title: Attendee
type: object
required:
- id
properties:
id:
type: string
format: uuid
example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
description: Attendee id
booth-staff-response:
title: Booth Staff
type: object
description: Booth staff with an associated ID.
allOf:
- $ref: '#/components/schemas/booth-staff-request'
properties:
id:
type: string
format: uuid
example: 4e0f5152-515e-11ee-be56-0242ac120002
description: ID of an exhibitor booth staff member.
readOnly: true
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'
parameters:
boothstaffId:
in: path
name: boothstaffId
description: ID of a booth staff member.
required: true
schema:
type: string
format: uuid
example: 4e0f5152-515e-11ee-be56-0242ac120002
adminId:
in: path
name: adminId
description: ID of an exhibitor admin.
required: true
schema:
type: string
format: uuid
example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
token:
name: token
in: query
description: 'The continuation token returned from a previous class. This must be a valid UUID v4 if provided.
This will override any other pageable parameters provided.
'
style: form
explode: true
schema:
type: string
example: 0e28af57-511f-47ab-ae46-46cd1ca51a1a
exhibitorId:
in: path
name: exhibitorId
description: ID of an exhibitor.
required: true
schema:
type: string
format: uuid
example: 4888db54-db22-11eb-8d19-0242ac130003
id6:
in: path
name: id
description: ID of an event.
required: true
schema:
type: string
format: uuid
example: 3db28cfc-db22-11eb-8d19-0242ac130003
limit:
name: limit
in: query
description: The maximum number of records to return per page.
style: form
explode: true
schema:
maximum: 200
minimum: 1
type: integer
default: 100
example: 100
responses:
TooManyRequests1:
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cvent-event-cloud/refs/heads/main/openapi/cvent-event-cloud-exhibitor-team-api-openapi.yml