Overview

Welcome to the guide for using Cvent’s REST API Reference. This guide walks you through each aspect of the interface, explaining the purpose of each component and how to read it effectively.

You can access the API reference at https://developers.cvent.com/documentation.

Interface

When you first visit the API reference, you’ll see the page has a three-pane layout.

• Navigation Menu provides an overview of all the categories and APIs available.
• Specifications Pane shows the details of the selected API endpoint.
• Samples Pane shows what requests and responses are expected to look like.

Navigation Menu

The navigation menu lets you browse through API endpoints and categories. Use the search bar to quickly find endpoints. Click on a category to expand it and view the related endpoints.

Specifications Pane

When you select an endpoint from the navigation menu, the center pane shows the specifications.

Request Details

Each endpoint has a title and a brief description of its purpose. Click Authorizations to expand details around authorization on this API. You’ll see the supported OAuth 2.0 methods for authentication.

• Flow Type: Indicates the authentication flow supported. See Authentication for more details on each type.
• Authorization URL: Denotes the correct authorization URL for this authentication flow. See Authentication for more details on each type.
• Token URL: Denotes the token URL. See Token for more details.
• Required Scopes: Denotes the scopes required in your authorization to use this endpoint. Read more about Scopes.

Some API endpoints support path parameters. A path parameter is a variable part of the URL path used to identify specific resources. If the path parameter exists, it’s name and description are shown.

Query parameters show which parameters you can add to the end of a request URL. Each API supports different parameters. Read the documentation to learn their capability.

POST endpoints outline the schema for the request body. Request bodies are expected to be in JSON format. The body schema shows each field or model that you can pass in a request.

Response Details

At the bottom, you’ll find information about the responses from the API you can receive when calling this endpoint. Each HTTP response code is color-coded with green denoting success, and red denoting a kind of failure. Clicking a response code expands it to show more details about what data will be included in each response.

Responses schemas are in JSON format and show each field or model that can appear in the response.

• Fields show their name (for example, subject, location, code), their format (string, number, etc), and a description. They’ll also show if they are required. Required fields must be returned in a response. If a field isn’t marked required, it’s not guaranteed to be present in a response.
• Models are denoted as an array of objects. Clicking the model expands it to show all the fields inside its array. Models marked required must be returned in a response. Required models must be returned in a response. If a model isn’t marked required, it’s not guaranteed to be present in a response.

Samples Pane

The rightmost pane contains samples for each API.

First is the endpoints address. This shows the expected URL to reach the API. Click the address to expand and see the URL for the NA and EU data centers.

For POST endpoints, a sample payload is shown. This mirrors the request body schema and shows example fields, arrays, and data.

APIs show response samples for each response code, mirroring the response schemas shown. The samples display example fields, arrays, and data. These sections can be expanded and closed.