Headers

• Authorization string

  Bearer token used for authorization

  Minimum length is 1.

• X-Correlation-Id string

  Unique identifier to allow referencing a particular transaction or event chain

  Minimum length is 1.

• Accept-Language string

  Returns the requested resources translated according to the passed languages (see translatable resources)

  Minimum length is 1.

Query parameters

• id array[string]

  ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• external-id array[string]

  External ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1, maximum length of each is 255.

• from string(date-time)

  Start date and time of the appointment to be considered for filtering (ISO 8601)

  Minimum length is 1.

• to string(date-time)

  End date and time of the appointment to be considered for filtering (ISO 8601)

  Minimum length is 1.

• meeting-type array[string]

  Meeting type(s) to be considered for filtering

  At least 1 element. Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.

• status array[string]

  Status(es) to be considered for filtering

  At least 1 element. Values are ACCEPTED, ALTERNATIVE_DATE_REQUESTED, CANCELLED, COMPLETED, INCOMING_REQUEST, NO_SHOW, or OUTGOING_INVITE.

• callback-request-id array[string]

  Callback request ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• listing-id array[string]

  Listing ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• lead-segment-id array[string]

  Lead segment ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• subject-id array[string]

  Subject ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• office-id array[string]

  Office ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• customer-id array[string]

  Customer ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• employee-id array[string]

  Employee ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• offset string(positive-integer)

  Offset for the results to be returned

  Default value is 0.

• limit string(positive-integer)

  Limitation for the number of results to be returned

  Default value is 25.

Responses

• 200 application/json

  Successful operation

  Hide response attributes Show response attributes object

  • data array[object] Required
    Hide data attributes Show data attributes object

    • id string Required

      Minimum length is 1.

    • externalId string | null

      Minimum length is 1, maximum length is 255.

    • start string(date-time) | null

      Minimum length is 1.

    • end string(date-time) | null

      Minimum length is 1.

    • subject object Required
      Hide subject attributes Show subject attributes object

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • office object Required
      Hide office attributes Show office attributes object

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • appointmentParticipants array[object] Required

      At least 2 elements.

      Hide appointmentParticipants attributes Show appointmentParticipants attributes object

      • role string Required

        Values are PRIMARY or SECONDARY.

      • participant object Required
        Hide participant attribute Show participant attribute object

        • id string Required

          Minimum length is 1.

      • type string Required

        Values are CUSTOMER or EMPLOYEE.

      • videoUrl string(uri) | null

        Minimum length is 1.

      • videoTestUrl string(uri) | null

        Minimum length is 1.

      • Additional properties are NOT allowed
    • answers array[object] Required
      Hide answers attributes Show answers attributes object

      • value string | null

        Minimum length is 1.

      • selectedAnswerOptions array[object] | null
        Hide selectedAnswerOptions attributes Show selectedAnswerOptions attributes object

        • id string Required

          Minimum length is 1.

        • Additional properties are NOT allowed
      • id string Required

        Minimum length is 1.

      • form object Required
        Hide form attributes Show form attributes object

        • id string Required

          Minimum length is 1.

        • Additional properties are NOT allowed
      • question object Required
        Hide question attributes Show question attributes object

        • id string Required

          Minimum length is 1.

        • Additional properties are NOT allowed
      • answerType string Required

        Values are APPOINTMENT_CANCELLATION, APPOINTMENT_COMPLETION, CALLBACK_REQUEST, QUALIFICATION, or SUBJECT_QUESTIONNAIRE.

      • createdAt string(date-time) Required

        Minimum length is 1.

      • updatedAt string(date-time) Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • callbackRequest object | null
      Hide callbackRequest attributes Show callbackRequest attributes object | null

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • listing object | null
      Hide listing attributes Show listing attributes object | null

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • leadSegment object | null
      Hide leadSegment attributes Show leadSegment attributes object | null

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • meetingType string Required

      Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.

    • status string Required

      Values are ACCEPTED, ALTERNATIVE_DATE_REQUESTED, CANCELLED, COMPLETED, INCOMING_REQUEST, NO_SHOW, or OUTGOING_INVITE.

    • hybrid boolean Required
    • trailingBufferTime integer Required

      Minimum value is 0.

    • internalNotes string | null

      Minimum length is 1.

    • metadata
    • createdAt string(date-time) Required

      Minimum length is 1.

    • createdBy object | null
      Hide createdBy attributes Show createdBy attributes object | null

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • createdByType string Required

      Values are CUSTOMER, EMPLOYEE, or OTHER.

    • createdFrom string Required

      Values are BACKOFFICE_APP, OTHER, PARTNER_BOOKING_APP, or PLUGIN.

    • updatedAt string(date-time) Required

      Minimum length is 1.

    • updatedBy object | null
      Hide updatedBy attributes Show updatedBy attributes object | null

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • updatedByType string Required

      Values are CUSTOMER, EMPLOYEE, or OTHER.

    • updatedFrom string Required

      Values are BACKOFFICE_APP, OTHER, PARTNER_BOOKING_APP, or PLUGIN.

    • location object | null
      Hide location attributes Show location attributes object | null

      • city object | null Required
        Hide city attributes Show city attributes object | null

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
        • Additional properties are NOT allowed
      • state object | null Required
        Hide state attributes Show state attributes object | null

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
        • Additional properties are NOT allowed
      • street1 object | null Required
        Hide street1 attributes Show street1 attributes object | null

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
        • Additional properties are NOT allowed
      • street2 object | null Required
        Hide street2 attributes Show street2 attributes object | null

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
        • Additional properties are NOT allowed
      • postalCode string | null

        Minimum length is 1.

      • countryCode string Required

        Minimum length is 2, maximum length is 2.

      • formattedAddress string Required

        Minimum length is 1.

      • geolocation object Required
        Hide geolocation attributes Show geolocation attributes object

        • latitude number Required

          Minimum value is -90, maximum value is 90.

        • longitude number Required

          Minimum value is -180, maximum value is 180.

        • Additional properties are NOT allowed
      • Additional properties are NOT allowed
    • Additional properties are NOT allowed
  • meta object Required
    Hide meta attributes Show meta attributes object

    • offset integer Required

      Minimum value is 0. Default value is 0.

    • limit integer Required

      Minimum value is 0. Default value is 25.

    • totalCount integer Required

      Minimum value is 0.

    • Additional properties are NOT allowed
  • Additional properties are NOT allowed