openapi: 3.2.0
info:
title: Cvent REST APIs — Event Cloud Surveys 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: Surveys
description: Surveys are lists of questions deployed to your contacts. Surveys can be standalone or can be associated to a Cvent event. Use these APIs to search for surveys and retrieve the associated questions and responses.
paths:
/events/surveys/responses:
get:
summary: List All Event Responses
description: Gets a paginated list of event survey responses for all events and surveys.
operationId: getAllEventSurveyResponses
security:
- OAuth2.clientCredentials:
- survey/survey-responses:read
- OAuth2.authorizationCode:
- survey/survey-responses:read
tags:
- Surveys
responses:
'200':
description: Successfully retrieved a paginated list of event survey responses.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/event-survey-responses-paginated-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'
deprecated: false
parameters:
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/before'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
- name: filter
in: query
required: false
description: 'Use filter query parameters to limit results
to data that matches your criteria. See
[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.
Supported fields and operators are listed below:
| Field | Operators |
|---------------|-------------|
| id | `eq`, `ne` |
| respondent.id | `eq`, `ne` |
| session.id | `eq`, `ne` |
| speaker.id | `eq`, `ne` |
| question.id | `eq`, `ne` |
| event.id | `eq`, `ne` |
'
schema:
type: string
example: id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3'
/events/{id}/surveys:
parameters:
- $ref: '#/components/parameters/id7'
get:
summary: List Event Surveys
description: Gets a paginated list of surveys (id refers to chapter id and parentId is the survey id) associated to a single event.
operationId: getEventSurveys
security:
- OAuth2.clientCredentials:
- survey/surveys:read
- OAuth2.authorizationCode:
- survey/surveys:read
tags:
- Surveys
responses:
'200':
description: Successfully retrieved a paginated list of event surveys (id refers to chapter id and parentId is the survey id).
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/event-surveys-paginated-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'
deprecated: false
parameters:
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/before'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
- name: filter
in: query
required: false
description: 'Use filter query parameters to limit results
to data that matches your criteria. See
[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.
Supported fields and operators are listed below:
| Field | Operators | Notes |
|----------|-------------|--------------------------------|
| id | `eq`, `ne` | chapter ID of the event survey |
| type | `eq`, `ne` | |
| sessions | `eq`, `ne` | |
The following logical operators are supported for combining filters:
* `and`
* `or`
'
schema:
type: string
example: id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3' and type eq 'Session Feedback' and sessions eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3' or sessions eq '05ca6ae2-0dc3-487b-953e-86d6abbdf7d3'
/events/{id}/surveys/{surveyId}/questions:
parameters:
- $ref: '#/components/parameters/id7'
- $ref: '#/components/parameters/surveyId'
get:
summary: List Event Survey Questions
description: Gets a paginated list of event survey questions for a given event and survey. The <a href="#operation/getLargeChoices"> GET List Large Choices </a> endpoint returns choices for the large choice question `type` (`LargeChoices`).
operationId: getEventSurveyQuestions
security:
- OAuth2.clientCredentials:
- survey/survey-questions:read
- OAuth2.authorizationCode:
- survey/survey-questions:read
tags:
- Surveys
responses:
'200':
description: Successfully retrieved a paginated list of event survey questions.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/event-survey-questions-paginated-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'
deprecated: false
parameters:
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/before'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
/events/{id}/surveys/{surveyId}/respondents:
parameters:
- $ref: '#/components/parameters/id7'
- $ref: '#/components/parameters/surveyId'
get:
summary: List Event Survey Respondents
description: Gets a paginated list of event survey respondents for a single event and survey.
operationId: getEventSurveyRespondents
security:
- OAuth2.clientCredentials:
- survey/survey-respondents:read
- OAuth2.authorizationCode:
- survey/survey-respondents:read
tags:
- Surveys
parameters:
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/before'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
- name: filter
in: query
required: false
description: 'Use filter query parameters to limit results
to data that matches your criteria. See
[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.
Supported fields and operators are listed below:
| Field | Operators |
|-------|-------------|
| id | `eq`, `ne` |
'
schema:
type: string
example: id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3'
responses:
'200':
description: Successfully retrieved a paginated list of event survey respondents.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/event-survey-respondents-paginated-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'
deprecated: false
post:
summary: Create Event Survey Respondent
description: Create a respondent for an event survey.
operationId: createEventSurveyRespondent
security:
- OAuth2.clientCredentials:
- survey/survey-respondents:write
- OAuth2.authorizationCode:
- survey/survey-respondents:write
tags:
- Surveys
requestBody:
description: Used to create respondent for an event survey.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/event-survey-respondent'
responses:
'201':
description: Successfully created respondent for event survey.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/event-survey-respondent'
'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'
deprecated: false
/events/{id}/surveys/{surveyId}/respondents/{respondentId}:
parameters:
- $ref: '#/components/parameters/id7'
- $ref: '#/components/parameters/surveyId'
- $ref: '#/components/parameters/respondentId'
put:
summary: Update Event Survey Respondent
description: Update respondent for an event survey.
operationId: updateEventSurveyRespondent
security:
- OAuth2.clientCredentials:
- survey/survey-respondents:write
- OAuth2.authorizationCode:
- survey/survey-respondents:write
tags:
- Surveys
requestBody:
description: Used to update a respondent for an event survey.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/event-survey-respondent'
responses:
'200':
description: Successfully updated respondent for event survey.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/event-survey-respondent'
'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'
deprecated: false
/events/{id}/surveys/{surveyId}/respondents/{respondentId}/responses:
parameters:
- $ref: '#/components/parameters/id7'
- $ref: '#/components/parameters/surveyId'
- $ref: '#/components/parameters/respondentId'
post:
summary: Create Event Survey Responses
description: Create responses for a particular respondent in an event survey.
operationId: createEventSurveyResponses
security:
- OAuth2.clientCredentials:
- survey/survey-responses:write
- OAuth2.authorizationCode:
- survey/survey-responses:write
tags:
- Surveys
requestBody:
description: Used to create responses for an event survey's respondent.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/event-survey-response'
responses:
'201':
description: Successfully created a response
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/event-survey-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'
deprecated: false
/events/{id}/surveys/{surveyId}/responses:
parameters:
- $ref: '#/components/parameters/id7'
- $ref: '#/components/parameters/surveyId'
get:
summary: List Event Survey Responses
description: Gets a paginated list of event survey responses for a single event and survey.
operationId: getEventSurveyResponses
security:
- OAuth2.clientCredentials:
- survey/survey-responses:read
- OAuth2.authorizationCode:
- survey/survey-responses:read
tags:
- Surveys
responses:
'200':
description: Successfully retrieved a paginated list of event survey responses.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/event-survey-responses-paginated-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'
deprecated: false
parameters:
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/before'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
- name: filter
in: query
required: false
description: 'Use filter query parameters to limit results
to data that matches your criteria. See
[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.
Supported fields and operators are listed below:
| Field | Operators |
|---------------|-------------|
| id | `eq`, `ne` |
| respondent.id | `eq`, `ne` |
| session.id | `eq`, `ne` |
| speaker.id | `eq`, `ne` |
| question.id | `eq`, `ne` |
'
schema:
type: string
example: id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3'
/large-choices:
get:
summary: List Large Choices
description: Gets a paginated list of choices for large choice question`type` (`LargeChoices`).
operationId: getLargeChoices
security:
- OAuth2.clientCredentials:
- survey/questions:read
- OAuth2.authorizationCode:
- survey/questions:read
tags:
- Surveys
responses:
'200':
description: Successfully retrieved a paginated list of large choices.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/large-choices-paginated-response'
'400':
$ref: '#/components/responses/BadRequest1'
'401':
$ref: '#/components/responses/Unauthorized1'
'403':
$ref: '#/components/responses/Forbidden1'
'429':
$ref: '#/components/responses/TooManyRequests1'
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
- name: filter
in: query
required: false
description: 'Use filter query parameters to limit results
to data that matches your criteria. See
[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.
Supported fields and operators are listed below:
| Field | Operators |
|-------------|-------------|
| id | `eq`, `ne` |
| question.id | `eq`, `ne` |
'
schema:
type: string
example: id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3'
/questions:
get:
summary: List Questions
description: Gets a paginated list of event and standalone survey questions. The <a href="#operation/getLargeChoices"> GET List Large Choices </a> endpoint returns choices for the large choice question `type` (`LargeChoices`).
operationId: getQuestions
security:
- OAuth2.clientCredentials:
- survey/questions:read
- OAuth2.authorizationCode:
- survey/questions:read
tags:
- Surveys
responses:
'200':
description: Successfully retrieved a paginated list of questions.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/questions-paginated-response'
'400':
$ref: '#/components/responses/BadRequest1'
'401':
$ref: '#/components/responses/Unauthorized1'
'403':
$ref: '#/components/responses/Forbidden1'
'429':
$ref: '#/components/responses/TooManyRequests1'
parameters:
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/before'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
- name: filter
in: query
required: false
description: 'Use filter query parameters to limit results
to data that matches your criteria. See
[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.
Supported fields and operators are listed below:
| Field | Operators |
|------------|------------------------------------|
| id | `eq`, `ne` |
| survey.id | `eq`, `ne` |
| code | `eq`, `ne` |
| type | `eq`, `ne` |
| chapter.id | `eq`, `ne` |
| maxScore | `eq`, `ne`, `gt`, `ge`, `lt`, `le` |
'
schema:
type: string
example: id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3'
/respondents:
get:
summary: List Respondents
description: Gets a paginated list of event and standalone surveys respondents.
operationId: getRespondents
parameters:
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/before'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
- name: filter
in: query
required: false
description: 'Use filter query parameters to limit results
to data that matches your criteria. See
[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.
Supported fields and operators are listed below:
| Field | Operators |
|-----------------------------|------------------------------------|
| id | `eq`, `ne` |
| survey.id | `eq`, `ne` |
| event.id | `eq`, `ne` |
| responseCode | `eq`, `ne` |
| score | `eq`, `ne`, `gt`, `ge`, `lt`, `le` |
| chapters.score | `eq`, `gt`, `ge`, `lt`, `le` |
| chapters.evaluationResult | `eq` |
| chapters.status | `eq` |
'
schema:
type: string
example: id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3'
security:
- OAuth2.clientCredentials:
- survey/respondents:read
- OAuth2.authorizationCode:
- survey/respondents:read
tags:
- Surveys
responses:
'200':
description: Successfully retrieved a paginated list of respondents.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/respondents-paginated-response'
'400':
$ref: '#/components/responses/BadRequest1'
'401':
$ref: '#/components/responses/Unauthorized1'
'403':
$ref: '#/components/responses/Forbidden1'
'429':
$ref: '#/components/responses/TooManyRequests1'
/responses:
get:
summary: List Responses
description: Gets a paginated list of event and standalone survey responses.
operationId: getResponses
security:
- OAuth2.clientCredentials:
- survey/responses:read
- OAuth2.authorizationCode:
- survey/responses:read
tags:
- Surveys
responses:
'200':
description: Successfully retrieved a paginated list of responses.
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/responses-paginated-response'
'400':
$ref: '#/components/responses/BadRequest1'
'401':
$ref: '#/components/responses/Unauthorized1'
'403':
$ref: '#/components/responses/Forbidden1'
'429':
$ref: '#/components/responses/TooManyRequests1'
parameters:
- $ref: '#/components/parameters/after'
- $ref: '#/components/parameters/before'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/token'
- name: filter
in: query
required: false
description: 'Use filter query parameters to limit results
to data that matches your criteria. See
[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.
Supported fields and operators are listed below:
| Field
# --- truncated at 32 KB (143 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cvent-event-cloud/refs/heads/main/openapi/cvent-event-cloud-surveys-api-openapi.yml