---
url: /apidocs/meeting.md
---
## Meeting API

| Endpoint | Method | Description |
|-----|-----|-----|
| [/api/v0/resource/meetingInvitation/{meetingId}](#get-ics-file-for-meeting-invitation) | webRequest | Get ICS file for meeting invitation |
| [/api/v0/resource/meetingSeriesInvitation/{seriesId}](#get-ics-file-for-meeting-series-invitation) | webRequest | Get ICS file for meeting series invitation |
| [/api/v0/resource/meetingSeriesOccurrenceInvitation/{seriesId}/{originalStartDate}](#get-ics-file-for-meeting-series-occurrence-invitation) | webRequest | Get ICS file for meeting series occurrence invitation |
| ~~[meeting:create](#create-meeting-deprecated)~~ | websocket | Create meeting: deprecated |
| ~~[meeting:update](#update-meeting-deprecated)~~ | websocket | Update meeting: deprecated |
| ~~[meeting:delete](#delete-meeting-deprecated)~~ | websocket | Delete meeting: deprecated |
| ~~[meeting:get](#get-meeting-deprecated)~~ | websocket | Get meeting: deprecated |
| ~~[meeting:checkPropHasMeetingsOrSocialSessions](#check-prop-has-meetings-or-social-sessions)~~ | websocket | Check prop has meetings or social sessions |
| ~~[meeting:listUserMeetingCounts](#list-user-meeting-counts)~~ | websocket | List user meeting counts |
| ~~[meeting:listUserMeetingsInDateRange](#list-user-meetings-in-date-range)~~ | websocket | List user meetings in date range |
| [meeting:getMeetingSeriesOccurrence](#get-meeting-series-occurrence) | websocket | Get meeting series occurrence |
| [meeting:updateMeetingSeriesOccurrence](#update-meeting-series-occurrence) | websocket | Update meeting series occurrence |
| [meeting:cancelMeetingSeriesOccurrence](#cancel-meeting-series-occurrence) | websocket | Cancel meeting series occurrence |
| [meeting:deleteMeetingSeriesOccurrence](#delete-meeting-series-occurrence) | websocket | Delete meeting series occurrence |
| [meeting:acceptMeetingRequest](#accept-meeting-request) | websocket | Accept meeting request |
| [meeting:declineMeetingRequest](#decline-meeting-request) | websocket | Decline meeting request |
| [meeting:createMeeting](#create-meeting) | websocket | Create meeting |
| [meeting:createMeetingSeries](#create-meeting-series) | websocket | Create meeting series |
| [meeting:updateMeeting](#update-meeting) | websocket | Update meeting |
| [meeting:updateMeetingSeries](#update-meeting-series) | websocket | Update meeting series |
| [meeting:deleteMeeting](#delete-meeting) | websocket | Delete meeting |
| [meeting:deleteMeetingSeries](#delete-meeting-series) | websocket | Delete meeting series |
| [meeting:getMeeting](#get-meeting) | websocket | Get meeting |
| [meeting:listUserMeetings](#list-user-meetings) | websocket | List user meetings |
| [meeting:listMeetingOccurrences](#list-meeting-occurrences) | websocket | List meeting occurrences |
| [meeting:getTimeSlotsForMeeting](#get-time-slots-for-meeting) | websocket | Get time slots for meeting |
| [meeting:getMeetingTimeSlotsForMonth](#get-meeting-time-slots-for-month) | websocket | Get meeting time slots for month |
| [meeting:setUserAvailability](#set-user-availability) | websocket | Set user availability |
| [meeting:getUserAvailabilityPattern](#get-user-availability-pattern) | websocket | Get user availability pattern |
| [meeting:getUserAvailabilityForDay](#get-user-availability-for-day) | websocket | Get user availability for day |
| [meeting:getUserAvailabilityForWeek](#get-user-availability-for-week) | websocket | Get user availability for week |
| [meeting:getUserAvailabilityForMonth](#get-user-availability-for-month) | websocket | Get user availability for month |
| ~~[meeting:meetingUpdated](#on-meeting-updated-event)~~ | websocketEvent | On meeting updated event |
| ~~[meeting:meetingDeleted](#on-meeting-deleted-event)~~ | websocketEvent | On meeting deleted event |
| [meeting:onMeetingCreated](#on-meeting-created-event) | websocketEvent | On meeting created event |
| [meeting:onMeetingSeriesCreated](#on-meeting-series-created-event) | websocketEvent | On meeting series created event |
| [meeting:onMeetingDeleted](#on-meeting-deleted-event) | websocketEvent | On meeting deleted event |
| [meeting:onMeetingSeriesDeleted](#on-meeting-series-deleted-event) | websocketEvent | On meeting series deleted event |
| [meeting:onMeetingUpdated](#on-meeting-updated-event) | websocketEvent | On meeting updated event |
| [meeting:onMeetingSeriesUpdated](#on-meeting-series-updated-event) | websocketEvent | On meeting series updated event |
| [meeting:onMeetingSeriesOccurrenceUpdated](#on-meeting-series-occurrence-updated-event) | websocketEvent | On meeting series occurrence updated event |

### Get ICS file for meeting invitation

**HTTP Method:** GET

**Path:** /api/v0/resource/meetingInvitation/{meetingId}

**Request:**

**Response:**

### Get ICS file for meeting series invitation

**HTTP Method:** GET

**Path:** /api/v0/resource/meetingSeriesInvitation/{seriesId}

**Request:**

**Response:**

### Get ICS file for meeting series occurrence invitation

**HTTP Method:** GET

**Path:** /api/v0/resource/meetingSeriesOccurrenceInvitation/{seriesId}/{originalStartDate}

**Parameters:**

originalStartDate: Unix timestamp of the occurrence start date

**Request:**

**Response:**

### Create meeting: deprecated

**Method:** websocket

**Endpoint:** meeting:create

**DEPRECATED**

**Description:** API will create "Meeting" requests to all invited users.

* All invited users will have "received" status for meeting;

* By accepting request invited user will receive "accepted" status for meeting;

* By declining request invited user will receive "declined" status for meeting;

**Request:**

**Response:**

### Update meeting: deprecated

**Method:** websocket

**Endpoint:** meeting:update

**DEPRECATED**

**Request:**

**Response:**

### Delete meeting: deprecated

**Method:** websocket

**Endpoint:** meeting:delete

**DEPRECATED**

**Request:**

**Response:**

### Get meeting: deprecated

**Method:** websocket

**Endpoint:** meeting:get

**DEPRECATED**

**Request:**

**Response:**

### Check prop has meetings or social sessions

**Method:** websocket

**Endpoint:** meeting:checkPropHasMeetingsOrSocialSessions

**DEPRECATED**

**Description:** API returns true if prop has at least one meeting or social session in the future.

**Request:**

**Response:**

### List user meeting counts

**Method:** websocket

**Endpoint:** meeting:listUserMeetingCounts

**DEPRECATED**

**Description:** API lists counts of meetings per day.

**Request:**

**Response:**

### List user meetings in date range

**Method:** websocket

**Endpoint:** meeting:listUserMeetingsInDateRange

**DEPRECATED**

**Description:** API lists user meetings in provided date range.

**Request:**

**Response:**

### Get meeting series occurrence

**Method:** websocket

**Endpoint:** meeting:getMeetingSeriesOccurrence

**Description:** API returns a single occurrence of a recurring meeting series. The occurrence is identified by seriesId + originalStartDate (the rrule-generated start date). If the occurrence was overridden, the returned data reflects the override (or its cancelled state).

**Request:**

**Response:**

### Update meeting series occurrence

**Method:** websocket

**Endpoint:** meeting:updateMeetingSeriesOccurrence

**Description:** API updates a single occurrence of a recurring meeting series without affecting other occurrences. The occurrence is identified by seriesId + originalStartDate (the rrule-generated start date). Provide updated subject, description, color, and optionally new start/end dates.

**Request:**

**Response:**

### Cancel meeting series occurrence

**Method:** websocket

**Endpoint:** meeting:cancelMeetingSeriesOccurrence

**Description:** API cancels a single occurrence of a recurring meeting series without affecting other occurrences. The occurrence is identified by seriesId + originalStartDate (the rrule-generated start date).

**Request:**

**Response:**

### Delete meeting series occurrence

**Method:** websocket

**Endpoint:** meeting:deleteMeetingSeriesOccurrence

**Description:** API removes the override for a single occurrence, restoring it to default series behavior.

**Request:**

**Response:**

### Accept meeting request

**Method:** websocket

**Endpoint:** meeting:acceptMeetingRequest

**Description:** API accepts user request for meeting and changes participant status to "accepted".

**Request:**

**Response:**

### Decline meeting request

**Method:** websocket

**Endpoint:** meeting:declineMeetingRequest

**Description:** API declines user request for meeting and changes participant status to "declined".

**Request:**

**Response:**

### Create meeting

**Method:** websocket

**Endpoint:** meeting:createMeeting

**Description:** API creates meeting in a provided location.

API will create "Meeting" requests to all invited users.

* All invited users will have "received" status for meeting;

* By accepting request invited user will receive "accepted" status for meeting;

* By declining request invited user will receive "declined" status for meeting;

**Request:**

**Response:**

### Create meeting series

**Method:** websocket

**Endpoint:** meeting:createMeetingSeries

**Description:** API creates meeting series in a provided location.

API will create "MeetingSeries" requests to all invited users.

* All invited users will have "received" status for meeting;

* By accepting request invited user will receive "accepted" status for meeting;

* By declining request invited user will receive "declined" status for meeting;

**Request:**

**Response:**

### Update meeting

**Method:** websocket

**Endpoint:** meeting:updateMeeting

**Request:**

**Response:**

### Update meeting series

**Method:** websocket

**Endpoint:** meeting:updateMeetingSeries

**Request:**

**Response:**

### Delete meeting

**Method:** websocket

**Endpoint:** meeting:deleteMeeting

**Request:**

**Response:**

### Delete meeting series

**Method:** websocket

**Endpoint:** meeting:deleteMeetingSeries

**Request:**

**Response:**

### Get meeting

**Method:** websocket

**Endpoint:** meeting:getMeeting

**Request:**

**Response:**

### List user meetings

**Method:** websocket

**Endpoint:** meeting:listUserMeetings

**Description:** API lists user meetings in provided date range.

**Request:**

**Response:**

### List meeting occurrences

**Method:** websocket

**Endpoint:** meeting:listMeetingOccurrences

**Description:** API lists meeting occurrences (single meetings and meeting series occurrences) in provided date range.

**Request:**

**Response:**

### Get time slots for meeting

**Method:** websocket

**Endpoint:** meeting:getTimeSlotsForMeeting

**Description:** API returns time intervals that are available for all requested users. Each requested user/email should be provided as separate element in array. API will ignore provided user if it is not found in the system.

**Request:**

**Response:**

### Get meeting time slots for month

**Method:** websocket

**Endpoint:** meeting:getMeetingTimeSlotsForMonth

**Description:** API returns time intervals that are available for all requested users. Each requested user/email should be provided as separate element in array. API will ignore provided user if it is not found in the system.

**Request:**

**Response:**

### Set user availability

**Method:** websocket

**Endpoint:** meeting:setUserAvailability

**Description:** API allows user to set times when he is available / not available to participate in meetings.

* If repetition parameter is provided, availability will be set as pattern for provided week days.

* If repetition parameter is not provided, availability will be set for mentioned day explicitly.

Status parameter is represented by one of: "Available" / "NotAvailable".

Repetition parameter is represented by a byte, meaning each bit (starting from right) is a day of the week, starting from Sunday (i.e. 00000101 translates to Sunday and Tuesday).

LocalDate parameter indicates with what date server should work.

**Request:**

**Response:**

### Get user availability pattern

**Method:** websocket

**Endpoint:** meeting:getUserAvailabilityPattern

**Request:**

**Response:**

### Get user availability for day

**Method:** websocket

**Endpoint:** meeting:getUserAvailabilityForDay

**Request:**

**Response:**

### Get user availability for week

**Method:** websocket

**Endpoint:** meeting:getUserAvailabilityForWeek

**Request:**

**Response:**

### Get user availability for month

**Method:** websocket

**Endpoint:** meeting:getUserAvailabilityForMonth

**Request:**

**Response:**

### On meeting updated event

**Event:** meeting:meetingUpdated

**DEPRECATED**

**Data:**

### On meeting deleted event

**Event:** meeting:meetingDeleted

**DEPRECATED**

**Data:**

### On meeting created event

**Event:** meeting:onMeetingCreated

**Data:**

### On meeting series created event

**Event:** meeting:onMeetingSeriesCreated

**Data:**

### On meeting deleted event

**Event:** meeting:onMeetingDeleted

**Data:**

### On meeting series deleted event

**Event:** meeting:onMeetingSeriesDeleted

**Data:**

### On meeting updated event

**Event:** meeting:onMeetingUpdated

**Data:**

### On meeting series updated event

**Event:** meeting:onMeetingSeriesUpdated

**Data:**

### On meeting series occurrence updated event

**Event:** meeting:onMeetingSeriesOccurrenceUpdated

**Description:** `override.isCancelled=true` when the occurrence is cancelled. `override.isCancelled=false` when the occurrence details were modified. `override` is null when the occurrence override was deleted (occurrence reverts to series defaults).

**Data:**

## Models

#### RGBA

#### Resource

#### Resource Origin

#### Geolocation

#### Dimensions

#### Resource Data Audio

#### Resource Data Video

#### Resource Data Amazon

#### Resource Data Imdb

#### Resource Data Youtube

#### Resource Data Vimeo

#### Resource Data Pinterest

#### Resource Data Pixabay

#### Resource Data Facebook

#### Resource Data Remote Url

#### Live Stream Data

#### AI Generation Data

#### Resource Data Directory

#### Google Drive

#### Channel Data

#### Enrichment Data

#### Programmatic Action with children

#### Programmatic Action

#### User Simple