Skip to content
Optiwork API Docs

Get the room's calendar event

GET
/rooms/{room}/calendar-event
curl --request GET \
  --url https://collab.work.optidata.cloud/api/rooms/a3050cd3-5921-4153-b90a-owt42-e94de63c7b15/calendar-event \
  --header 'Authorization: Bearer <token>'

The Optiwork Calendar event that uses this room as its video conference, by its link or its permanent link. When several events use the same room (a permanent link reused every week), the one happening now is returned; otherwise the next upcoming one; otherwise the most recent past one.

Answers 204 with no body when no event uses the room. Anyone who addresses the room by its link (hash or custom_hash) may read it.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
room
required
string

The room’s hash (from its link) or its permanent-link identifier custom_hash.

Responses

Section titled “ Responses ”

200

Section titled “200”

The linked event.

Media typeapplication/json
object
name
string | null
description
string | null
location
string | null
start

Start time, as Calendar reports it.

string | null
end

End time, as Calendar reports it.

string | null
is_all_day
boolean
organizer
One of:
object
name
string | null
email
string | null
avatar_url
string | null
participation_status

The person’s answer to the invitation, as recorded in Calendar.

string | null
is_organizer
boolean
attendees
Array<object>
object
name
string | null
email
string | null
avatar_url
string | null
participation_status

The person’s answer to the invitation, as recorded in Calendar.

string | null
is_organizer
boolean
Examples
Exampleevent
{
  "name": "Weekly sync",
  "description": "Agenda in the shared document.",
  "location": null,
  "start": "2026-10-20T13:00:00+00:00",
  "end": "2026-10-20T13:30:00+00:00",
  "is_all_day": false,
  "organizer": {
    "name": "Ana Souza",
    "email": "ana.souza@example.com",
    "avatar_url": null,
    "participation_status": null,
    "is_organizer": true
  },
  "attendees": [
    {
      "name": "Bruno Lima",
      "email": "bruno.lima@example.com",
      "avatar_url": null,
      "participation_status": "accepted",
      "is_organizer": false
    }
  ]
}

204

Section titled “204”

No calendar event uses this room.

401

Section titled “401”

No authentication key was sent, or it is malformed.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The room was not addressed by its link (hash or custom_hash), and the caller is not its owner, one of its participants or a company super-administrator.

Media typeapplication/json

A refused or not-found request.

object
message
required
string
Examples
Exampledenied
{
  "message": "You do not have permission to view this room."
}

404

Section titled “404”

No room has this hash or permanent link.

Media typeapplication/json

A refused or not-found request.

object
message
required
string
Examples
ExamplenotFound
{
  "message": ""
}

419

Section titled “419”

The authentication key is expired or not recognised. Get a fresh one and retry.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Exampleexpired
{
  "error": "JWT passport expired: Passport expired"
}