Skip to main content

Get calendar event

Gets a calendar event by ID

Function GetCalendarEvent(Val URL, Val EventID, Val Token = "") Export

ParameterCLI optionTypeRequiredDescription
URL--urlString✔URL of webhook or a Bitrix24 domain, when token used
EventID--eventNumber✔Event ID to retrieve
Token--tokenString✖Access token, when app auth method used
Returns

Map Of KeyAndValue - serialized JSON of answer from Bitrix24 API

tip

Method at API documentation: calendar.event.getbyid


1C:Enterprise/OneScript code example
    URL     = "https://b24-ar17wx.bitrix24.by/rest/1/av5...";
    EventID = "3042";

    Result = OPI_Bitrix24.GetCalendarEvent(URL, EventID);

    URL     = "b24-ar17wx.bitrix24.by";
    Token   = "a5b00469006e9f06006b12e400000001000...";
    EventID = "3046";

    Result = OPI_Bitrix24.GetCalendarEvent(URL, EventID, Token);
    oint bitrix24 GetCalendarEvent \
      --url "b24-ar17wx.bitrix24.by" \
      --event 4684 \
      --token "***"
Result
{
 "result": {
  "ID": "4684",
  "PARENT_ID": "4684",
  "DELETED": "N",
  "CAL_TYPE": "user",
  "OWNER_ID": "1",
  "NAME": "New event",
  "DATE_FROM": "27.05.2026 14:16:00",
  "DATE_TO": "27.05.2026 15:16:00",
  "ORIGINAL_DATE_FROM": "***",
  "TZ_FROM": "Europe/Minsk",
  "TZ_TO": "Europe/Minsk",
  "TZ_OFFSET_FROM": "10800",
  "TZ_OFFSET_TO": "10800",
  "DATE_FROM_TS_UTC": "1779869782",
  "DATE_TO_TS_UTC": "1782476160",
  "DT_SKIP_TIME": "N",
  "DT_LENGTH": 3600,
  "EVENT_TYPE": null,
  "CREATED_BY": "1",
  "DATE_CREATE": "26.05.2026 17:16:23",
  "TIMESTAMP_X": "26.05.2026 17:16:23",
  "DESCRIPTION": "Event description",
  "PRIVATE_EVENT": "1",
  "ACCESSIBILITY": "quest",
  "IMPORTANCE": "normal",
  "IS_MEETING": true,
  "MEETING_STATUS": "H",
  "MEETING_HOST": "1",
  "MEETING": {
   "HOST_NAME": "Антон Титовец",
   "NOTIFY": true,
   "REINVITE": "***",
   "ALLOW_INVITE": "***",
   "HIDE_GUESTS": true,
   "MEETING_CREATOR": 1,
   "LANGUAGE_ID": "ru",
   "MAIL_FROM": false
  },
  "LOCATION": "Office",
  "REMIND": [
   {
    "type": "day",
    "count": 1
   }
  ],
  "COLOR": "#230000",
  "RRULE": {
   "FREQ": "DAILY",
   "COUNT": 3,
   "INTERVAL": 10,
   "UNTIL": "06.06.2026",
   "~UNTIL": "06.06.2026",
   "UNTIL_TS": 1780704000
  },
  "EXDATE": "",
  "DAV_XML_ID": "20260527T111600Z-483c1c257cc19a7abc259a4f9647906a@b24-ar17wx.bitrix24.by",
  "G_EVENT_ID": "",
  "DAV_EXCH_LABEL": "",
  "CAL_DAV_LABEL": "",
  "VERSION": "1",
  "ATTENDEES_CODES": [
   "U1",
   "U10"
  ],
  "RECURRENCE_ID": null,
  "RELATIONS": "",
  "SECTION_ID": "2476",
  "SYNC_STATUS": null,
  "UF_CRM_CAL_EVENT": null,
  "UF_WEBDAV_CAL_EVENT": null,
  "SECTION_DAV_XML_ID": null,
  "DATE_FROM_FORMATTED": "Wed May 27 2026 14:16:00",
  "DATE_TO_FORMATTED": "Wed May 27 2026 15:16:00",
  "IS_DAYLIGHT_SAVING_TZ": "N",
  "SECT_ID": "2476",
  "OPTIONS": null,
  "ATTENDEE_LIST": [
   {
    "id": 1,
    "entryId": "4684",
    "status": "H"
   },
   {
    "id": 10,
    "entryId": "4686",
    "status": "Q"
   }
  ],
  "COLLAB_ID": null,
  "~RRULE_DESCRIPTION": "каждый 10-й день, от 27.05.2026 до 06.06.2026",
  "attendeesEntityList": [
   {
    "entityId": "user",
    "id": 1
   },
   {
    "entityId": "user",
    "id": 10
   }
  ],
  "~DESCRIPTION": "Event description",
  "~USER_OFFSET_FROM": 0,
  "~USER_OFFSET_TO": 0
 },
 "time": {
  "start": 1779804989,
  "finish": 1779804989.12446,
  "duration": 0.124456882476807,
  "processing": 0,
  "date_start": "2026-05-26T14:16:29+00:00",
  "date_finish": "2026-05-26T14:16:29+00:00",
  "operating_reset_at": 1779805589,
  "operating": 0
 }
}