Workspaces

List workspace calendar events

One window of the workspace calendar, `start` to `end` (ISO 8601 with offset, at most 7 days apart, plus an hour for a week that crosses a DST change; the start's offset decides which days teammates'

GET /v2/workspaces/{workspaceId}/calendar/events

Parameters

Path parameters

workspaceId
string (uuid) required

Query parameters

start
string (date-time) required
end
string (date-time) required

Responses

200 — Successful response

Content-Type: application/json

data
object required
data.calendar_events
array<object> required
data.calendar_events[].providerId
string required
data.calendar_events[].type
string enum required
Possible values: "EMAIL", "CALENDAR"
data.calendar_events[].subjectOrTitle
string required
data.calendar_events[].dateTime
string (date-time) required
data.calendar_events[].endDateTime
string (date-time)
data.calendar_events[].isAllDay
boolean | null
data.calendar_events[].participants
array<object> required
data.calendar_events[].participants[].email
string required
data.calendar_events[].participants[].name
string | null
data.calendar_events[].providerLink
string | null
data.calendar_events[].email
string required
data.calendar_events[].iCalUID
string | null
data.calendar_events[].summaryOfEvent
string | null
data.calendar_events[].descriptionOfEvent
string | null
data.calendar_events[].conferenceData
object | null
data.calendar_events[].conferenceData.conferenceId
string | null
data.calendar_events[].conferenceData.entryPoints
array<object> | null
data.calendar_events[].conferenceData.entryPoints[].uri
string | null
data.calendar_events[].conferenceData.entryPoints[].label
string | null
data.calendar_events[].conferenceData.entryPoints[].accessCode
string | null
data.calendar_events[].isRecurring
boolean | null
data.calendar_events[].provider
string | null
data.pagination
object
data.pagination.nextCursor
string | null
data.pagination.count
integer
data.warnings
array<string>
Incomplete results: some connected calendars could not be read.
data.shared_events
array<object> required
data.shared_events[].id
string required
data.shared_events[].type
string enum required
Possible values: "EMAIL", "CALENDAR"
data.shared_events[].thread_id
string | null required
data.shared_events[].date
string (date-time) required
data.shared_events[].end_date
string (date-time) | null required
data.shared_events[].is_all_day
boolean required
data.shared_events[].member_user_ids
array<string> required
data.shared_events[].visibility
string enum required
Possible values: "metadata", "full"
data.shared_events[].subject
string required
data.shared_events[].from
object | null required
data.shared_events[].from.email
string required
data.shared_events[].from.name
string | null required
data.shared_events[].participants
array<object> required
data.shared_events[].participants[].email
string required
data.shared_events[].participants[].name
string | null required
data.shared_events[].participants[].role
string enum required
Possible values: "from", "to", "cc", "attendee", "organizer"
data.shared_events[].snippet
string | null required
data.shared_events[].description
string | null required
data.shared_events[].has_body
boolean required
data.shared_events[].provider
string enum required
Possible values: "GOOGLE", "OFFICE365"

Example

{
  "data": {
    "calendar_events": [
      {
        "providerId": "string",
        "type": "EMAIL",
        "subjectOrTitle": "string",
        "dateTime": "2026-10-23T10:31:51.494Z",
        "participants": [
          {
            "email": "string"
          }
        ],
        "email": "string"
      }
    ],
    "shared_events": [
      {
        "id": "string",
        "type": "EMAIL",
        "thread_id": "string",
        "date": "2026-10-23T10:31:51.494Z",
        "end_date": "2026-10-23T10:31:51.494Z",
        "is_all_day": false,
        "member_user_ids": [
          "string"
        ],
        "visibility": "metadata",
        "subject": "string",
        "from": {
          "email": "string",
          "name": "string"
        },
        "participants": [
          {
            "email": "string",
            "name": "string",
            "role": "from"
          }
        ],
        "snippet": "string",
        "description": "string",
        "has_body": false,
        "provider": "GOOGLE"
      }
    ]
  }
}

400 — Request body failed validation.

Content-Type: application/json

(body)
any

401 — Missing or invalid API key.

Content-Type: application/json

(body)
any

403 — Valid key, insufficient permission.

Content-Type: application/json

(body)
any

404 — Resource does not exist.

Content-Type: application/json

(body)
any

409 — Request conflicts with the current state of the resource.

Content-Type: application/json

(body)
any

429 — Rate limit exceeded.

Content-Type: application/json

(body)
any

500 — Unexpected server error.

Content-Type: application/json

(body)
any

Code samples

curl 'https://api.prod.getdex.com/v2/workspaces/00000000-0000-0000-0000-000000000000/calendar/events?start=2026-10-23T10:31:51.493Z&end=2026-10-23T10:31:51.493Z' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Copyright © 2026