calendar

Query calendar events

Lists all calendar events that match the given query parameters. The POST body is the query object.

post/calendar/events/list

Request

  • Base URL: https://api.ritten.io/v1
  • URL: https://api.ritten.io/v1/calendar/events/list
  • Auth: none declared

Request body

entityIdsstring[]
startTimestring required

ISO Format DateTime

endTimestring required

ISO Format DateTime

Example request

{
  "entityIds": [
    "f87e1b07-1d20-4c36-8c37-08600daf7322"
  ],
  "startTime": "2024-02-13T13:00:00-05:00",
  "endTime": "2024-02-13T23:59:59-05:00"
}

Response

success

idstring
titlestring
descriptionstring
locationstring
startTimestring
endTimestring
frequency'day' | 'week' | 'month' | 'yeah' | 'custom'
interval'0m' | '15m' | '30m' | '1h' | '24h' | '2d' | '3d' nullable
daysOfWeekstring[]
untilstring nullable

Example response

{
  "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
  "title": "Therapy Appointment",
  "startTime": "2024-02-13T13:00:00-05:00",
  "endTime": "2024-02-13T13:00:00-05:00",
  "until": "2024-02-13T13:00:00-05:00"
}

Changes

No recorded changes to this operation across all 1 revision of this API.