Cvent Event Cloud Appointments API

openapi: 3.2.0
info:
  title: Cvent Event Cloud Appointments API
  version: ea
  contact:
    name: Cvent Development Platform
    url: https://developers.cvent.com/
  description: 'Operations tagged Appointments across 2 of this provider''s published API definitions: cvent-event-cloud-rest-openapi.yml, cvent-rest-apis-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-platform.cvent.com/ea
- url: https://api-platform-eur.cvent.com/ea
tags:
- name: Appointments
  description: "An appointment is a meeting scheduled between two or more parties. These APIs allow you to get\n information about your Cvent Appointments: appointment attendees, their interests, and availabilities.\n\n\n* **Appointment Events** - Appointment events help planners facilitate meetings between attendees. Attendees express their interest and availability to schedule appointments. Use this API to get information about appointments and appointment attendees.\n\n* **Appointment Attendees** - Appointment attendees are meeting participants. They can be attendees of either events or appointment events. Get information about these participants or use their appointment attendee ID to get their availabilities and interests.\n\n* **Availability** - Appointment availabilities describe an appointment attendees' preference in meeting dates and times. Availability information is only available for *Planner Coordinated Appointments*.\n\n* **Interests** - Appointment interests describe appointment attendees' preferences in meeting with another organization or individual. Interest information is only available for *Planner Coordinated Appointments*.\n* **Available Times** - Available times lists time ranges available  for appointments scheduling.\n* **Locations** - Locations lists details of all locations created for  scheduling appointments.\n* **Appointment Types** - Appointment Types lists details of different  appointment types created.\n"
paths:
  /appointment-attendees:
    get:
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointment-attendees:read
      - OAuth2.authorizationCode:
        - appointments/appointment-attendees:read
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - 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''.


          There are six comparison types that can be used in filter expressions:

          * equal: eq

          * not equal: ne

          * greater than: gt

          * greater or equal: ge

          * less than: lt

          * less than or equal: le


          The following fields are filterable:

          * appointmentEvent.id (eq)

          * contact.id (eq)

          * deleted (eq)


          The following operators are available:

          * and'
        schema:
          type: string
          example: appointmentEvent.id eq 'd165ad63-4bec-449d-aa9e-054fc7fcbb71' and contact.id eq 'da561161-8e80-4c70-9663-750cbc2045f6' and deleted eq 'false'
      summary: List Appt Attendees
      description: Gets a paginated list of appointment attendees.
      operationId: listAppointmentAttendees
      responses:
        '200':
          description: Successfully retrieved a paginated response of appointment attendees.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appointment-attendee-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointment-attendees/{id}:
    parameters:
    - $ref: '#/components/parameters/appointmentAttendeeId'
    get:
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointment-attendees:read
      - OAuth2.authorizationCode:
        - appointments/appointment-attendees:read
      summary: Get Appt Attendee
      description: Gets a single appointment attendee by their ID.
      operationId: getAppointmentAttendeeById
      responses:
        '200':
          description: Successfully retrieved an appointment attendee.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appointment-attendee'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointment-availability-times:
    get:
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointment-attendees:read
      - OAuth2.authorizationCode:
        - appointments/appointment-attendees:read
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - 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''.


          There are six comparison types that can be used in filter expressions:

          * equal: eq

          * not equal: ne

          * greater than: gt

          * greater or equal: ge

          * less than: lt

          * less than or equal: le


          The following fields are filterable:

          * appointmentEvent.id (eq)

          * attendee.id (eq)


          No operators are available'
        schema:
          type: string
          example: appointmentEvent.id eq 'd165ad63-4bec-449d-aa9e-054fc7fcbb71'
      summary: List Availability
      description: Gets a paginated list of appointment availability times.
      operationId: listAvailability
      responses:
        '200':
          description: Successfully retrieved a paginated list of appointment availability times.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appointment-availability-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointment-availability-times/{id}:
    parameters:
    - $ref: '#/components/parameters/appointmentAvailabilityTimeId'
    get:
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointment-attendees:read
      - OAuth2.authorizationCode:
        - appointments/appointment-attendees:read
      summary: Get Availability
      description: Get a single appointment availability time by its ID.
      operationId: getAvailabilityById
      responses:
        '200':
          description: Successfully retrieved an appointment availability time.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appointment-availability'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          description: Response 429 is required for public operations with rate limiting
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointment-events:
    get:
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointment-events:read
      - OAuth2.authorizationCode:
        - appointments/appointment-events:read
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - 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''.


          There are six comparison types that can be used in filter expressions:

          * equal: eq

          * not equal: ne

          * greater than: gt

          * greater or equal: ge

          * less than: lt

          * less than or equal: le


          The following fields are filterable:

          * event.id (eq)


          No operators are available'
        schema:
          type: string
          example: event.id eq 'd165ad63-4bec-449d-aa9e-054fc7fcbb71'
      summary: List Appt Events
      description: Gets a paginated list of appointment events.
      operationId: listAppointmentEvents
      responses:
        '200':
          description: Successfully retrieved a paginated list of appointment events.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appointment-event-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointment-events/{id}:
    parameters:
    - $ref: '#/components/parameters/appointmentEventId'
    get:
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointment-events:read
      - OAuth2.authorizationCode:
        - appointments/appointment-events:read
      summary: Get Appt Event
      description: Gets a single appointment event by its ID.
      operationId: getAppointmentEventById
      responses:
        '200':
          description: Successfully retrieved an appointment event.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appointment-event'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointment-events/{id}/appointment-available-times:
    get:
      parameters:
      - $ref: '#/components/parameters/appointmentEventId'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - 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''.


          There are six comparison types that can be used in filter expressions:

          * equal: eq

          * not equal: ne

          * greater than: gt

          * greater or equal: ge

          * less than: lt

          * less than or equal: le


          The following fields are filterable:

          * appointmentType.id (eq)

          * location.id (eq)


          No operators are available'
        schema:
          type: string
          example: appointmentType.id eq '2925dd1c-7b02-4e34-8881-18f2360b50a7'
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/available-times:read
      - OAuth2.authorizationCode:
        - appointments/available-times:read
      summary: List Available Times
      description: Gets a paginated list of times and locations available for scheduling appointments in a particular appointment event.
      operationId: listAvailableTimes
      responses:
        '200':
          description: Successfully retrieved a paginated list of times and locations available to schedule appointments in a particular appointment event.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/available-times-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
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointment-events/{id}/appointment-types:
    get:
      parameters:
      - $ref: '#/components/parameters/appointmentEventId'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointment-types:read
      - OAuth2.authorizationCode:
        - appointments/appointment-types:read
      summary: List Appointment Types
      description: Gets a paginated list of appointment types for an appointment event.
      operationId: listAppointmentTypes
      responses:
        '200':
          description: Successfully retrieved a paginated list of appointment types.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appointment-types-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
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointment-events/{id}/appointments:
    post:
      parameters:
      - $ref: '#/components/parameters/appointmentEventId'
      - $ref: '#/components/parameters/suppressNotifications'
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointments:write
      - OAuth2.authorizationCode:
        - appointments/appointments:write
      summary: Create Appointment
      description: Creates an appointment in a given appointment event.
      operationId: createAppointment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create-appointment-request'
      responses:
        '201':
          description: Successfully created an appointment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appointment-with-questions'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '422':
          $ref: '#/components/responses/UnprocessableEntity1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointment-events/{id}/appointments/{apptId}:
    put:
      parameters:
      - $ref: '#/components/parameters/appointmentEventId'
      - $ref: '#/components/parameters/apptId'
      - $ref: '#/components/parameters/suppressNotifications'
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointments:write
      - OAuth2.authorizationCode:
        - appointments/appointments:write
      summary: Update Appointments
      description: Updates an appointment based on the given ID.
      operationId: updateAppointment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update-appointment-request'
      responses:
        '200':
          description: Successfully updated an appointment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appointment-with-questions'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '422':
          $ref: '#/components/responses/UnprocessableEntity1'
        '429':
          $ref: '#/components/responses/TooManyRequests1'
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    delete:
      parameters:
      - $ref: '#/components/parameters/appointmentEventId'
      - $ref: '#/components/parameters/apptId'
      - $ref: '#/components/parameters/suppressNotifications'
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointments:write
      - OAuth2.authorizationCode:
        - appointments/appointments:write
      summary: Cancel Appointment
      description: Cancels an appointment with the given appointment ID.
      operationId: cancelAppointment
      responses:
        '204':
          description: Successfully cancelled an appointment.
        '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'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointment-events/{id}/locations:
    get:
      parameters:
      - $ref: '#/components/parameters/appointmentEventId'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/locations:read
      - OAuth2.authorizationCode:
        - appointments/locations:read
      summary: List Locations
      description: Gets a paginated list of appointment locations in a particular appointment event.
      operationId: listLocations
      responses:
        '200':
          description: Successfully retrieved a paginated list of appointment locations for a particular appointment event.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/locations-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
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointment-meeting-interests:
    get:
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointment-attendees:read
      - OAuth2.authorizationCode:
        - appointments/appointment-attendees:read
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - 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''.


          There are six comparison types that can be used in filter expressions:

          * equal: eq

          * not equal: ne

          * greater than: gt

          * greater or equal: ge

          * less than: lt

          * less than or equal: le


          The following fields are filterable:

          * appointmentEvent.id (eq)

          * attendee.id (eq)


          No operators are available'
        schema:
          type: string
          example: appointmentEvent.id eq 'd165ad63-4bec-449d-aa9e-054fc7fcbb71'
      summary: List Interests
      description: Gets a paginated list of appointment meeting interests.
      operationId: listMeetingInterests
      responses:
        '200':
          description: Successfully retrieved a paginated list of appointment meeting interests.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attendee-appointment-meeting-interests-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          description: Response 429 is required for public operations with rate limiting
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointment-meeting-interests/{id}:
    parameters:
    - $ref: '#/components/parameters/appointmentMeetingInterestId'
    get:
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointment-attendees:read
      - OAuth2.authorizationCode:
        - appointments/appointment-attendees:read
      summary: Get Interest
      description: Gets a single attendee's meeting interests in a particular appointment event by their interest ID.
      operationId: getMeetingInterestById
      responses:
        '200':
          description: Successfully retrieved an attendees appointment meeting interests in the given event.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/attendee-appointment-meeting-interest'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          description: Response 429 is required for public operations with rate limiting
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointments:
    get:
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointments:read
      - OAuth2.authorizationCode:
        - appointments/appointments:read
      parameters:
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/before'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/token'
      - 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''.


          There are six comparison types that can be used in filter expressions:

          * equal: eq

          * not equal: ne

          * greater than: gt

          * greater or equal: ge

          * less than: lt

          * less than or equal: le


          The following fields are filterable:

          * appointmentEvent.id (eq)

          * participants.attendee.contact.id (eq)

          * code (eq)


          No operators are available'
        schema:
          type: string
          example: appointmentEvent.id eq 'ad0ea301-1203-4fee-a7d2-54165ba14e2d'
      summary: List Appointments
      description: Gets a paginated list of appointments.
      operationId: listAppointments
      responses:
        '200':
          description: Successfully retrieved a paginated list of appointments.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appointment-paginated-response'
        '400':
          $ref: '#/components/responses/BadRequest1'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '429':
          description: Response 429 is required for public operations with rate limiting
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
  /appointments/{id}:
    parameters:
    - $ref: '#/components/parameters/appointmentId'
    get:
      tags:
      - Appointments
      security:
      - OAuth2.clientCredentials:
        - appointments/appointments:read
      - OAuth2.authorizationCode:
        - appointments/appointments:read
      summary: Get Appointment
      description: Gets a single appointment by its ID.
      operationId: getAppointmentById
      responses:
        '200':
          description: Successfully retrieved an appointment.
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/appointment-with-questions'
        '401':
          $ref: '#/components/responses/Unauthorized1'
        '403':
          $ref: '#/components/responses/Forbidden1'
        '404':
          $ref: '#/components/responses/NotFound1'
        '429':
          description: Response 429 is required for public operations with rate limiting
      deprecated: false
      externalDocs:
        description: More about OAuth2 authorization code support for administrators
        url: '#oauth2-auth-code-planner-admin'
    servers:
    - url: https://api-platform.cvent.com/ea
    - url: https://api-platform-eur.cvent.com/ea
components:
  schemas:
    appointment-participant.json:
      title: AppointmentParticipant
      description: An appointment participant.
      type: object
      required:
      - attendee
      - type
      x-extends:
        $ref: '#/components/schemas/audit.json'
      allOf:
      - $ref: '#/components/schemas/audit.json'
      properties:
        attendee:
          type: object
          description: Reference information for the attendee.
          properties:
            id:
              type: string
              description: The unique ID representing the attendee.
              readOnly: true
              example: 0cdfa3f7-05da-4121-857b-d7732891e01a::52a68001-70ce-4ec4-a6fe-d0888123c715
            contact:
              $ref: '#/components/schemas/uuid.json'
          example:
            id: dd1057b9-a957-4c22-be88-741a29d01471/97f2ca58-0f9e-401f-a6b5-a6f20d3a9568
            contact:
              id: 97f2ca58-0f9e-401f-a6b5-a6f20d3a9568
        type:
          $ref: '#/components/schemas/participant-type.json'
        response:
          $ref: '#/components/schemas/participant-response.json'
        participation:
          type: object
          description: The attendee's participation status.
          properties:
            participated:
              type: boolean
              description: True indicates the attendee was marked as a participant in the appointment.
              example: true
          example:
            participated: true
        questionViewer:
          type: boolean
          description: True indicates custom questions are visible to appointment participant.
          example: false
        privateNoteViewer:
          type: boolean
          description: True indicates private notes are visible to the appointment participant.
          example: false
        deleted:
          type: boolean
          description: True indicates the participant was removed from the appointment.
          example: false
        status:
          $ref: '#/components/schemas/participant-status.json'
    appointment-types-paginated-response:
      title: Appointment Types Paginated Response
      type: object
      description: The response for a request of appointment types configured for scheduling appointments.
      properties:
        paging:
          $ref: '#/components/schemas/paging.json'
        data:
          type: array
          items:
            $ref: '#/components/schemas/appointment-type.json'
          description: The collection of appointment types object.
    available-time.json:
      title: Available Times
      description: Time availability fo

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