{ "item": [ { "id": "691a931e-f2d3-4185-ac49-746cacae645b", "name": "Event Credits", "description": { "content": "Event Credits reward attendees for participating in your events. Planners can award credits for the entire event, specific sessions, or both. You can also award credits after attendees complete surveys. Use these APIs to retrieve credit details for your attendees.", "type": "text/plain" }, "item": [ { "id": "2ea85070-ac4c-48c5-840c-d4881a5f063a", "name": "List Attendee Event Credits", "request": { "name": "List Attendee Event Credits", "description": { "content": "Gets a paginated list of attendee event credits in your account.", "type": "text/plain" }, "url": { "path": [ "attendee-credits" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "after", "value": "", "description": "Used to query records that have been added or updated after this time point. Default to the beginning of time of the data store." }, { "disabled": false, "key": "before", "value": "", "description": "Used to query records that have been added or updated before this time point." }, { "disabled": false, "key": "limit", "value": "100", "description": "The maximum number of records to return per page." }, { "disabled": false, "key": "token", "value": "", "description": "The continuation token returned from a previous class. This must be a valid UUID v4 if provided.\nThis will override any other pageable parameters provided.\n" }, { "disabled": false, "key": "sort", "value": "", "description": "The `sort` query parameter sorts items in the list of results and organizes them according to your preference.\nThere are two orders:\n * ascending: ASC\n * descending: DESC\n\nThe following fields are sortable:\n * lastModified\n" }, { "disabled": false, "key": "expand", "value": ",", "description": "Use the `expand` query parameter to include additional related information in the response. For each specified value, the related entity is retrieved and displayed inline.\n\nAn expandable object typically contains the ID of a related object in its response properties.\n\nThe following fields are expandable:\n * creditType(Includes only the `creditType.name` in the response. A full list of properties for `creditType` is not currently provided).\n" }, { "disabled": false, "key": "filter", "value": "", "description": "A filter query string narrows search\nresults and supports the combination of logical and comparison\noperators.\n\nThe filter adheres to the pattern filter='field' comparisonType 'value'.\n\nThese are the comparison types that can be used in filter expressions:\n * equal: eq\n * not equal: ne\n\nThe following fields are filterable:\n* attendee.id (eq|ne)\n* event.id (eq|ne)\n* session.id (eq|ne)\n* creditType.id (eq|ne)\n* type (eq)\n\nNote:\n* lastModified: Used by the 'before' and 'after' filters.\n" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": { "type": "oauth2", "oauth2": [ { "key": "scope", "value": "account/hooks:delete account/hooks:read account/hooks:write account/user-groups:delete account/user-groups:read account/user-groups:write account/users:delete account/users:read account/users:write appointments/appointment-attendees:read appointments/appointment-events:read appointments/appointment-types:read appointments/appointments:read appointments/appointments:write appointments/available-times:read appointments/locations:read attendee-insights/attendee-insights:read attendee-insights/scores:read attendee-insights/stats:read budget/budget-items:delete budget/budget-items:read budget/budget-items:write budget/budget-totals:read budget/budget-vendors:read budget/cards:read budget/currency-conversion-rate:delete budget/currency-conversion-rate:read budget/currency-conversion-rate:write budget/payments:delete budget/payments:read budget/payments:write budget/transactions:delete budget/transactions:read budget/transactions:write bulk/bulk-jobs:read bulk/bulk-jobs:write business-transient/bids:read business-transient/proposals:read business-transient/supplier-brands:read business-transient/supplier-chains:read business-transient/supplier-properties:read business-transient/supplier-property-rooms:read business-transient/travel-accounts:read business-transient/travel-program-questions:read business-transient/travel-programs:read business-transient/travel-supplier-accounts:read business-travel/bids:read business-travel/proposals:read business-travel/travel-accounts:read business-travel/travel-program-questions:read business-travel/travel-programs:read compliance/communications:read compliance/communications:write email/bounces:read email/email-status:read email/emails:read eMarketing/campaigns:read emarketing/emarketing-email-status:read eMarketing/eMarketing-email-templates:read eMarketing/eMarketing-send-emails:write event/admission-items:read event/air-request:read event/alternate-travel:read event/attendance-durations:read event/attendee-activities-metadata:delete event/attendee-activities-metadata:read event/attendee-activities-metadata:write event/attendee-activities:read event/attendee-activities:write event/attendee-credits:read event/attendee-links:delete event/attendee-links:read event/attendee-links:write event/attendee-messages:read event/attendees:read event/attendees:write event/audience-segments:read event/audience-segments:write event/contact-groups:read event/contact-groups:write event/contact-types:read event/contacts:delete event/contacts:read event/contacts:write event/contacts:write-sensitive event/custom-fields:read event/custom-fields:write event/discounts:write event/donation-items:read event/event-discounts:read event/event-discounts:write event/event-email-status:read event/event-emails:read event/event-emails:write event/event-features:read event/event-features:write event/event-user-groups:read event/event-user-groups:write event/events:read event/events:write event/fee-items:read event/hotel-request:read event/invitation-lists:read event/meeting-request-forms:read event/meeting-requests:read event/meeting-requests:write event/membership-items:read event/orders:read event/planning-documents:read event/players:read event/process-form-submissions:read event/program-items:delete event/program-items:read event/program-items:write event/quantity-items:read event/quantity-items:write event/registration-paths:read event/registration-types:read event/registration-types:write event/role-assignments:read event/session-attendance:read event/session-attendance:write event/session-categories:read event/session-categories:write event/session-enrollment:delete event/session-enrollment:read event/session-enrollment:write event/session-segments:read event/sessions:delete event/sessions:read event/sessions:write event/speaker-categories:read event/speaker-categories:write event/speakers:delete event/speakers:read event/speakers:write event/taxes:read event/transactions:read event/transactions:write event/video-views:read event/videos:read event/videos:write event/vouchers:read event/webcasts:delete event/webcasts:read event/webcasts:write event/weblinks:read events-plus/hubs:read exhibitor/badges:read exhibitor/badges:write exhibitor/booth-staff:delete exhibitor/booth-staff:read exhibitor/booth-staff:write exhibitor/eliterature-requests:read exhibitor/exhibitor-admins:read exhibitor/exhibitor-admins:write exhibitor/exhibitor-answers:read exhibitor/exhibitor-answers:write exhibitor/exhibitor-categories:delete exhibitor/exhibitor-categories:read exhibitor/exhibitor-categories:write exhibitor/exhibitor-contents:delete exhibitor/exhibitor-contents:read exhibitor/exhibitor-contents:write exhibitor/exhibitor-questions:read exhibitor/exhibitors:delete exhibitor/exhibitors:read exhibitor/exhibitors:write exhibitor/lead-qualification-answers:read exhibitor/lead-qualification-questions:read exhibitor/leads:read exhibitor/registration-packs:delete exhibitor/registration-packs:read exhibitor/registration-packs:write exhibitor/sponsorship-levels:read file/file:read file/file:write housing/connections:write housing/hotel-room-rates:write housing/housing-event-available-nights:read housing/housing-event-hotels:read housing/housing-event-inventory:read housing/housing-event-room-types:read housing/housing-events:read housing/reservation-requests:delete housing/reservation-requests:read housing/reservation-requests:write housing/reservations-link:delete housing/reservations-link:write housing/reservations:delete housing/reservations:read housing/reservations:write onsite/signatures:read proposal/proposals:write remote-printing/badge-print-jobs:read remote-printing/badge-print-jobs:write remote-printing/badge-printer-pools:read rfp/rfp-agenda-items:read rfp/rfp-attachments:read rfp/rfp-custom-fields:read rfp/rfp-guest-rooms:read rfp/rfp-internal-documents:read rfp/rfp-lead-sources:read rfp/rfp-past-events:read rfp/rfp-questions:read rfp/rfp-recipients-history:read rfp/rfp-suppliers:read rfp/rfps:read seating/assignments:read seating/event-seatings:read seating/seats:read seating/tables:read secure-ecommerce/card-tokens:write survey/questions:read survey/respondents:read survey/responses:read survey/standard-survey-email-templates:read survey/standard-survey-email:write survey/standard-survey-questions:read survey/standard-survey-respondents:read survey/standard-survey-respondents:write survey/standard-survey-responses:read survey/standard-survey-responses:write survey/standard-surveys:read survey/survey-questions:read survey/survey-respondents:read survey/survey-respondents:write survey/survey-responses:read survey/survey-responses:write survey/surveys:read venue/meeting-room-overviews:read venue/meeting-rooms:write venue/venue-details-overview:read venue/venue-details:write venue/venue-facility:write" }, { "key": "accessTokenUrl", "value": "https://api-platform.cvent.com/ea/oauth2/token" }, { "key": "grant_type", "value": "client_credentials" } ] } }, "response": [ { "id": "2767e77b-5bc7-4c30-aed2-176c73f7d1eb", "name": "Successfully retrieved a paginated list of event credits for attendees.", "originalRequest": { "url": { "path": [ "attendee-credits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after", "value": "2017-01-02T02:00:00Z" }, { "key": "before", "value": "2017-01-02T02:00:00Z" }, { "key": "limit", "value": "100" }, { "key": "token", "value": "0e28af57-511f-47ab-ae46-46cd1ca51a1a" }, { "key": "sort", "value": "lastModified:DESC" }, { "key": "expand", "value": "creditType" }, { "key": "filter", "value": "attendee.id eq '{UUID}'" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"paging\": {\n \"_links\": {\n \"next\": {\n \"href\": \"?token=90c5f062-76ad-4ea4-aa53-00eb698d9262\"\n },\n \"self\": {\n \"href\": \"?token=90c5f062-76ad-4ea4-aa53-00eb698d9262\"\n },\n \"prev\": {\n \"href\": \"?token=90c5f062-76ad-4ea4-aa53-00eb698d9262\"\n }\n },\n \"previousToken\": \"1a2b3c4d5e6f7g8h9i10j11k\",\n \"nextToken\": \"1a2b3c4d5e6f7g8h9i10j11k\",\n \"currentToken\": \"1a2b3c4d5e6f7g8h9i10j11k\",\n \"limit\": 100,\n \"totalCount\": 2\n },\n \"data\": [\n {\n \"id\": \"1db28cfc-db22-11eb-8d19-0242ac130003_6ef33f60-64c7-4f92-81e5-af717da5c398_c15d600b-1363-413e-b00a-87d946903fe1\",\n \"type\": \"Session\",\n \"creditType\": {\n \"id\": \"c15d600b-1363-413e-b00a-87d946903fe1\"\n },\n \"amount\": 20,\n \"attendee\": {\n \"id\": \"1db28cfc-db22-11eb-8d19-0242ac130003\"\n },\n \"event\": {\n \"id\": \"3db28cfc-db22-11eb-8d19-0242ac130003\"\n },\n \"session\": {\n \"id\": \"6ef33f60-64c7-4f92-81e5-af717da5c398\"\n },\n \"created\": \"2024-01-05T03:00:00Z\",\n \"lastModified\": \"2024-01-07T02:00:00Z\"\n },\n {\n \"id\": \"1db28cfc-db22-11eb-8d19-0242ac130003_6ef33f60-64c7-4f92-81e5-af717da5c398_c15d600b-1363-413e-b00a-87d946903fe1\",\n \"type\": \"Session\",\n \"creditType\": {\n \"id\": \"c15d600b-1363-413e-b00a-87d946903fe1\"\n },\n \"amount\": 20,\n \"attendee\": {\n \"id\": \"1db28cfc-db22-11eb-8d19-0242ac130003\"\n },\n \"event\": {\n \"id\": \"3db28cfc-db22-11eb-8d19-0242ac130003\"\n },\n \"session\": {\n \"id\": \"6ef33f60-64c7-4f92-81e5-af717da5c398\"\n },\n \"created\": \"2024-01-05T03:00:00Z\",\n \"lastModified\": \"2024-01-07T02:00:00Z\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fc7f8b4-a20d-4775-be03-4453c9bdce0b", "name": "Bad request", "originalRequest": { "url": { "path": [ "attendee-credits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after", "value": "2017-01-02T02:00:00Z" }, { "key": "before", "value": "2017-01-02T02:00:00Z" }, { "key": "limit", "value": "100" }, { "key": "token", "value": "0e28af57-511f-47ab-ae46-46cd1ca51a1a" }, { "key": "sort", "value": "lastModified:DESC" }, { "key": "expand", "value": "creditType" }, { "key": "filter", "value": "attendee.id eq '{UUID}'" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 400,\n \"message\": \"Bad Request\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "72a2828b-5ca9-49c8-a540-6481a3582e08", "name": "Bad or expired token", "originalRequest": { "url": { "path": [ "attendee-credits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after", "value": "2017-01-02T02:00:00Z" }, { "key": "before", "value": "2017-01-02T02:00:00Z" }, { "key": "limit", "value": "100" }, { "key": "token", "value": "0e28af57-511f-47ab-ae46-46cd1ca51a1a" }, { "key": "sort", "value": "lastModified:DESC" }, { "key": "expand", "value": "creditType" }, { "key": "filter", "value": "attendee.id eq '{UUID}'" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 401,\n \"message\": \"Unauthorized\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b37f7393-655e-4b19-95b9-38944ce65138", "name": "You do not have access to the resource", "originalRequest": { "url": { "path": [ "attendee-credits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after", "value": "2017-01-02T02:00:00Z" }, { "key": "before", "value": "2017-01-02T02:00:00Z" }, { "key": "limit", "value": "100" }, { "key": "token", "value": "0e28af57-511f-47ab-ae46-46cd1ca51a1a" }, { "key": "sort", "value": "lastModified:DESC" }, { "key": "expand", "value": "creditType" }, { "key": "filter", "value": "attendee.id eq '{UUID}'" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 403,\n \"message\": \"Access Forbidden\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1c6735a9-70f0-4170-8631-42d1d2675763", "name": "Resource not found", "originalRequest": { "url": { "path": [ "attendee-credits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after", "value": "2017-01-02T02:00:00Z" }, { "key": "before", "value": "2017-01-02T02:00:00Z" }, { "key": "limit", "value": "100" }, { "key": "token", "value": "0e28af57-511f-47ab-ae46-46cd1ca51a1a" }, { "key": "sort", "value": "lastModified:DESC" }, { "key": "expand", "value": "creditType" }, { "key": "filter", "value": "attendee.id eq '{UUID}'" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 404,\n \"message\": \"Not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "731f063a-97a6-4e7e-a12c-f9b0683b4cdd", "name": "Too many requests", "originalRequest": { "url": { "path": [ "attendee-credits" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "after", "value": "2017-01-02T02:00:00Z" }, { "key": "before", "value": "2017-01-02T02:00:00Z" }, { "key": "limit", "value": "100" }, { "key": "token", "value": "0e28af57-511f-47ab-ae46-46cd1ca51a1a" }, { "key": "sort", "value": "lastModified:DESC" }, { "key": "expand", "value": "creditType" }, { "key": "filter", "value": "attendee.id eq '{UUID}'" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: oauth2", "type": "text/plain" }, "key": "Authorization", "value": "" }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"code\": 429,\n \"message\": \"Limit Exceeded\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "type": "string", "value": "https://api-platform.cvent.com/ea", "key": "baseUrl" } ], "info": { "_postman_id": "316d111a-a824-4733-bb78-a377ae977832", "name": "Cvent REST APIs — Event Cloud Event Credits API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "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\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\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
\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
\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
\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
\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\n\nContact Support:\n Name: Cvent Development Platform", "type": "text/plain" } } }