Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
calendar

Returns calendar events, condensed when there are too many of a single entry on a particular day

get/v2/org/{orgId}/calendar-event/condensed

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

startDatestring date required

Date to get events from, inclusive

endDatestring date required

Date to get events until, inclusive

filterstring

Optional CQL filter to apply to employee events

calendarIdsstring

Calendar IDs to filter by, comma-separated

maxEntriesPerCalendarPerDayinteger

Maximum number of individual entries to show for a particular calendar on any given day (default 6)

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "orgId": "588f7ee98f138b19220041a7",
      "calendarId": "588f7ee98f138b19220041a7",
      "singleEntry": {
        "id": "665f68b537795e0cb768bb74",
        "orgId": "665f3ad1e47a82bf1d3d180b",
        "calendarId": "665f3aabe88164e4ef6c3a22",
        "from": "2024-02-29",
        "until": "2024-04-01",
        "entityType": "PERSON",
        "entityId": "665f6952552f7e3e5beea7c9",
        "personId": "665f6952552f7e3e5beea7c9",
        "createId": "588f7ee98f138b19220041a7",
        "createBehalfId": "588f7ee98f138b19220041a7",
        "createAttribution": {
          "principalUserId": "588f7ee98f138b19220041a7",
          "agentUserIds": [
            "588f7ee98f138b19220041a7"
          ],
          "eventId": "588f7ee98f138b19220041a7",
          "aiChatId": "588f7ee98f138b19220041a7"
        },
        "createAt": "2017-01-24T13:57:52Z",
        "updateId": "588f7ee98f138b19220041a7",
        "updateBehalfId": "588f7ee98f138b19220041a7",
        "updateAttribution": {
          "principalUserId": "588f7ee98f138b19220041a7",
          "agentUserIds": [
            "588f7ee98f138b19220041a7"
          ],
          "eventId": "588f7ee98f138b19220041a7",
          "aiChatId": "588f7ee98f138b19220041a7"
        },
        "updateAt": "2017-01-24T13:57:52Z",
        "deleteId": "588f7ee98f138b19220041a7",
        "deleteBehalfId": "588f7ee98f138b19220041a7",
        "deleteAttribution": {
          "principalUserId": "588f7ee98f138b19220041a7",
          "agentUserIds": [
            "588f7ee98f138b19220041a7"
          ],
          "eventId": "588f7ee98f138b19220041a7",
          "aiChatId": "588f7ee98f138b19220041a7"
        },
        "deleteAt": "2017-01-24T13:57:52Z"
      }
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}