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.

Path parameters

• id string Required

  Primary identifier of the requested resource

  Minimum length is 1.

Query parameters

• external-calendar-id string | null
• show-as array[string]

  Status to be considered for filtering

  At least 1 element. Values are BUSY, FREE, or TENTATIVE.

• id array[string]

  ID(s) to be considered for filtering

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

• from string(date-time) Required

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

  Minimum length is 1.

• to string(date-time) Required

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

  Minimum length 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, number between 1 and 1000.

  Format should match the following pattern: ^([1-9]|[1-9][0-9]{1,2}|1000)$. 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.

    • externalCalendar object Required

      Additional properties are NOT allowed.

      Hide externalCalendar attribute Show externalCalendar attribute object

      • id string Required

        Minimum length is 1.

    • start string(date-time) Required

      Minimum length is 1.

    • end string(date-time) Required

      Minimum length is 1.

    • allDay boolean Required
    • showAs string Required

      Values are BUSY, FREE, or TENTATIVE.

    • title string | null

      Minimum length is 1.

    • description string | null

      Minimum length is 1.

    • resourceType string | null

      Values are APPOINTMENT, LISTING_TIME_SLOT, or SYNC_AVAILABILITY.

    • resourceId string | null

      Minimum length is 1.

    • private boolean Required
    • createdAt string(date-time) Required

      Minimum length is 1.

    • updatedAt string(date-time) Required

      Minimum length is 1.

  • meta object Required

    Additional properties are NOT allowed.

    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.

• 404 application/json

  Resource not found

  Hide response attribute Show response attribute object

  • errors array[object] Required

    At least 1 element.

    Hide errors attributes Show errors attributes object

    • message string Required

      Minimum length is 1.

    • code string Required

      Minimum length is 1.

    • type string Required

      Minimum length is 1.

    • statusCode string Required

      Minimum length is 1.