v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB

Events

Retrieve all events.

Required scopes: flex.collaboration.events.read

get/api/v2/organizations/{orgSlug}/events

Path parameters

orgSlugstring required

organization slug

Query parameters

locationstring

Example:603dfbc260f4054084125d33

Filter by event location id.

startstring

Example:start[$gte]=2024-01-01T06:00:00Z

Filter by start date of the event. An event can only <b>span</b> the same day. Supports date comparison filters: $gt, $gte, $lt, $lte

endstring

Example:end[$gte]=2024-01-01T12:00:00Z

Filter by end date of the event. An event can only <b>span</b> the same day. Supports date comparison filters: $gt, $gte, $lt, $lte

modifiedAtstring

Example:modifiedAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Filter by the modified date. Supports date comparison filters: $gt, $gte, $lt, $lte

createdAtstring

Example:createdAt[$gte]=YYYY-MM-DDTHH:mm:ssZ

Support date comparison filters: $gt, $gte, $lt, $lte

$selectstring

Example:recipient,sender

Select fields to return

$cursorNextstring

$cursorPrevstring

$limitnumber

Response

rangeStartnumber

rangeEndnumber

cursorNextstring

cursorPrevstring

Example response

{
  "results": [
    {
      "_id": "603dfbc260f4054084125d30",
      "start": "2024-01-01T06:00:00Z",
      "end": "2024-01-01T12:00:00Z",
      "timezone": "America/New_York",
      "title": "Lunch and Learn",
      "location": "603dfbc260f4054084125d33",
      "locations": [
        "603dfbc260f4054084125d33",
        "603dfbc260f4054084125d34"
      ],
      "description": "Join us for a lunch and learn session.",
      "where": "Conference Room 1",
      "company": "603dfbc260f4054084125d33",
      "member": "603dfbc260f4054084125d33",
      "limit": 20,
      "links": [
        "https://www.google.com",
        "https://app.officernd.com"
      ],
      "image": "https://www.google.com/image.png"
    }
  ]
}