Cvent Event Cloud Leads API

* **Leads -** Leads include leads gathered by LeadCapture, Appointments, and Inbound Leads. Use this API to get information for the lead and how it was captured. * **Lead Qualification Question -** Custom questions created by each exhibitor to qualify a lead. Questions and answers are their own endpoints. * **Eliterature Requests -** List of E-literature requests data sent to lead.

OpenAPI Specification

cvent-event-cloud-leads-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Cvent REST APIs — Event Cloud Leads 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: Leads
  description: '* **Leads -** Leads include leads gathered by LeadCapture, Appointments, and Inbound Leads. Use this API to get information for the lead and how it was captured.


    * **Lead Qualification Question -** Custom questions created by each exhibitor to qualify a lead. Questions and answers are their own endpoints.


    * **Eliterature Requests -** List of E-literature requests data sent to lead.

    '
paths:
  /eliterature-requests:
    get:
      summary: List E-literature Requests
      description: Gets a paginated list of eliterature requests data
      operationId: getEliteratureRequests
      tags:
      - Leads
      security:
      - OAuth2.clientCredentials:
        - exhibitor/eliterature-requests:read
      - OAuth2.authorizationCode:
        - exhibitor/eliterature-requests:read
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/after'
      - name: filter
        in: query
        required: false
        description: 'A filter query string narrows search results and supports the combination of logical and comparison operators.

          The filter adheres to the pattern filter=''field'' comparisonType ''value''.


          These are the comparison types that can be used in filter expressions:

          * equal: eq


          The following fields are filterable:

          * event.id (eq)

          * exhibitor.id (eq)

          * lead.id (eq)

          '
        schema:
          type: string
          example: event.id eq '{UUID}' and exhibitor.id eq '{UUID}' and lead.id eq '{UUID}'
      responses:
        '200':
          description: Successfully retrieved a paginated list of eliterature requests data.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eliterature-request-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '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}/leads/{leadId}/answers:
    get:
      summary: List Qualification Answers
      description: Gets a list of answers to lead qualification questions for a given lead id.
      operationId: getLeadQualificationAnswers
      tags:
      - Leads
      security:
      - OAuth2.clientCredentials:
        - exhibitor/lead-qualification-answers:read
      - OAuth2.authorizationCode:
        - exhibitor/lead-qualification-answers:read
      parameters:
      - $ref: '#/components/parameters/id6'
      - $ref: '#/components/parameters/exhibitorId'
      - $ref: '#/components/parameters/leadId'
      responses:
        '200':
          description: Successfully retrieved a list of Lead Qualification Answers.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lead-qualification-answers-list-response'
        '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'
  /leads:
    get:
      summary: List Leads
      description: Gets a paginated list of leads
      operationId: getLeads
      tags:
      - Leads
      security:
      - OAuth2.clientCredentials:
        - exhibitor/leads:read
      - OAuth2.authorizationCode:
        - exhibitor/leads:read
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/after'
      - name: filter
        in: query
        required: false
        description: 'A filter query string narrows search results and supports the combination of logical and comparison operators.

          The filter adheres to the pattern filter=''field'' comparisonType ''value''.


          These are the comparison types that can be used in filter expressions:

          * equal: eq


          The following fields are filterable:

          * event.id (eq)

          * exhibitor.id (eq)

          * deleted (eq)

          '
        schema:
          type: string
          example: deleted eq 'true' and event.id eq '{UUID}' and exhibitor.id eq '{UUID}'
      responses:
        '200':
          description: Successfully retrieved a paginated list of leads.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/leads-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'
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
  /leads/filter:
    post:
      summary: List Leads
      description: Gets a paginated list of leads
      operationId: getLeadsPostFiltersData
      tags:
      - Leads
      security:
      - OAuth2.clientCredentials:
        - exhibitor/leads:read
      - OAuth2.authorizationCode:
        - exhibitor/leads:read
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/after'
      requestBody:
        description: See the filter query parameter of <a href="#operation/getLeads">GET  Gets a paginated list of leads</a> for full filtering information
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/filter'
            example:
              filter: id eq '04ca6ae2-0dc3-487b-953e-86d6abbdf7d3' AND attendee.id eq 'edf40757-3bc3-4a66-8180-93bff15b890b'
      responses:
        '200':
          description: Successfully retrieved a paginated list of leads.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/leads-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'
      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
    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
    BoothStaff:
      title: Booth Staff
      type: object
      description: A JSON schema representing Booth Staff entity
      properties:
        id:
          type: string
          format: uuid
          example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
          description: Booth Staff id
    Lead-1:
      title: Lead
      type: object
      description: Lead object representing a lead captured at an event
      allOf:
      - $ref: '#/components/schemas/Audit'
      properties:
        event:
          $ref: '#/components/schemas/Event3'
        exhibitor:
          $ref: '#/components/schemas/Exhibitor'
        attendee:
          $ref: '#/components/schemas/Attendee-1'
        boothStaff:
          $ref: '#/components/schemas/BoothStaff'
        device:
          $ref: '#/components/schemas/Device'
        appointment:
          $ref: '#/components/schemas/Appointment1'
        title:
          type: string
          description: The title of the lead
          example: Mr.
        firstName:
          type: string
          description: The first name of the lead
          example: Henry
        lastName:
          type: string
          description: The last name of the lead
          example: Potterfield
        email:
          type: string
          format: email
          description: The email address of the lead
          example: h.potterfield@test.com
        company:
          type: string
          description: The company/organization the lead belongs to.
          example: Cvent Inc
        mobilePhone:
          type: string
          description: Mobile phone number of the lead
          maxLength: 30
          example: 555-555-5555
        homeAddress:
          $ref: '#/components/schemas/Address-11'
        homePhone:
          type: string
          description: Home phone number of the lead
          example: 555-555-5555
        workAddress:
          $ref: '#/components/schemas/Address-11'
        workPhone:
          type: string
          description: Work Phone number of the lead
          example: 555-555-5555
        type:
          description: The type of lead.
          type: string
          default: leadcapture
          enum:
          - leadcapture
          - inbound
          - appointment
        application:
          description: The application used to capture lead.
          type: string
          default: leadcapture
          enum:
          - leadcapture
          - attendeehub_mobile
          - attendeehub_web
          - appointment_app
        source:
          description: The source of entry for the lead
          type: string
          enum:
          - scanned
          - manual
          - business_card_scanned
          - ulc_scanned
          - inbound
          - appointment
        deleted:
          description: A boolean indicating whether a lead is deleted or not
          type: boolean
          default: false
        comments:
          type: string
          description: Comments about the lead
          example: I am interested in your product.
        licenseCode:
          description: License (access code) that was used to capture the lead
          type: string
          example: nag1248
        matched:
          description: A boolean indicating whether the lead is matched or not
          type: boolean
          example: true
        transcriptionStatus:
          description: Current status of business card transcription
          type: string
          enum:
          - pending
          - submitted
          - completed
          - failed
        qualified:
          description: A boolean indicating whether a lead is qualified or not
          type: boolean
          example: true
        additionalBadgekitFields:
          description: Map containing extra properties from badgekit provider
          type: object
    ELiteratureDocument:
      title: E-literature Document
      type: object
      description: A JSON schema representing an E-literature Document
      required:
      - id
      - displayName
      - type
      properties:
        id:
          type: string
          format: uuid
          example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
          description: Document identifier
        displayName:
          type: string
          example: Marketing Material
          description: Document display name
        type:
          description: Type of eliterature document
          enum:
          - FILE
          - LINK
          type: string
          example: FILE
    Appointment1:
      title: Appointment
      description: A JSON schema representing the structure of an appointment object.
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
          description: Appointment id
    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.
    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
    Attendee-1:
      title: Attendee
      type: object
      description: A JSON schema representing the Attendee object
      properties:
        id:
          type: string
          format: uuid
          example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
          description: Attendee id
    Address-11:
      title: Address
      description: Schema for address information
      type: object
      properties:
        address1:
          type: string
          description: The first line of an address
          example: Cvent Inc.
        address2:
          type: string
          description: The second line of an address
          example: 4001 West Parmer Lane
        city:
          type: string
          description: The name of the city.
          example: Austin
        region:
          type: string
          description: The name of the state/province/region of the address.
          example: Texas
        regionCode:
          type: string
          description: The abbreviation of the state/province/region of the address.
          example: TX
        postalCode:
          type: string
          description: postal code (also known as zipcode) of the address
          example: '78727'
        country:
          type: string
          description: Name of the country for example, 'United States'
          example: United States of America
        countryCode:
          type: string
          description: ISO 3166 two-letter (alpha-2) country code
          example: US
    Lead-2:
      title: Lead
      type: object
      required:
      - id
      properties:
        id:
          type: string
          format: uuid
          example: 4e74f930-db22-11eb-8d19-0242ac130003
          description: Lead id
      description: JSON schema for the Lead object
    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
    leads-paginated-response:
      title: LeadsPaginatedResponse
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        data:
          type: array
          items:
            $ref: '#/components/schemas/Lead'
          description: Collection of leads.
      description: A paginated response of leads.
    Device:
      title: Device
      type: object
      description: A JSON object representing an electronic device used to capture leads.
      properties:
        id:
          type: string
          description: The id of device used to capture lead
          example: EKEK993IF9F
        name:
          type: string
          description: The name of device used to capture lead
          example: North Gate
    Lead:
      title: Lead
      type: object
      description: A JSON Schema file for Lead.
      allOf:
      - $ref: '#/components/schemas/Lead-1'
      properties:
        id:
          type: string
          format: uuid
          example: cdd0d110-3a84-4bc5-a420-37c007716c73
          description: ID of Lead.
          readOnly: true
    lead-qualification-answers-list-response:
      title: Lead Qualification Answers List Response
      type: object
      description: A JSON schema representing the response for a list of lead qualification answers.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/LeadQualificationAnswers'
          description: Collection of Lead Qualification Answers.
    AnswerType:
      title: AnswerType
      enum:
      - Choice
      - Text
      - ChoiceText
      - Other
      - NA
      type: string
      description: Type of answer
      example: File
    filter:
      title: A filter sent in the body of a request
      description: A filter which is sent through the body of the request.
      type: object
      properties:
        filter:
          type: string
          example: property eq 'value'
          description: Filter included in the request.
    ELiteratureRequestDataForLead:
      title: E-literature Request Data for Lead
      type: object
      description: E-literature request data containing event, exhibitor, lead, and documents information.
      required:
      - event
      - exhibitor
      - lead
      - documents
      allOf:
      - $ref: '#/components/schemas/Audit'
      properties:
        event:
          $ref: '#/components/schemas/Event3'
        exhibitor:
          $ref: '#/components/schemas/Exhibitor'
        lead:
          $ref: '#/components/schemas/Lead-2'
        documents:
          type: array
          items:
            $ref: '#/components/schemas/ELiteratureDocument'
          minItems: 1
          maxItems: 25
          description: Collection of E-literature documents sent to lead.
    ExistingELiteratureRequestDataForLead:
      title: Existing E-literature Request Data for Lead
      type: object
      allOf:
      - $ref: '#/components/schemas/ELiteratureRequestDataForLead'
      properties:
        id:
          type: string
          format: uuid
          example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
          description: Request identifier
          readOnly: true
      description: A JSON Schema for an existing e-literature request data for a lead.
    LeadQualificationAnswers:
      title: Lead Qualification Answers
      description: This JSON schema file represents lead qualification answers
      type: object
      allOf:
      - $ref: '#/components/schemas/Audit'
      properties:
        id:
          type: string
          format: uuid
          example: 04ca6ae2-0dc3-487b-953e-86d6abbdf7d3
          description: Lead Qualification Answer id
        question:
          $ref: '#/components/schemas/UUID'
        event:
          $ref: '#/components/schemas/Event3'
        exhibitor:
          $ref: '#/components/schemas/Exhibitor'
        lead:
          $ref: '#/components/schemas/Lead-2'
        answers:
          description: List of answers
          type: array
          items:
            $ref: '#/components/schemas/Answer-1'
    Answer-1:
      title: Answer
      type: object
      required:
      - type
      description: An object representing the possible answers for lead qualification questions.
      properties:
        type:
          $ref: '#/components/schemas/AnswerType'
        value:
          type: string
          description: 'Answered value like: Choice text, text answer input etc.'
          example: Choice A
        choice:
          $ref: '#/components/schemas/UUID'
    eliterature-request-paginated-response:
      title: E-literature Request Paginated Response
      type: object
      description: A paginated response for E-literatu

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cvent-event-cloud/refs/heads/main/openapi/cvent-event-cloud-leads-api-openapi.yml