Sign in
latestOpenAPI 3.0.02026-08-1027587.8 KB

3d9aec0774ff

Get meeting

Returns the specified meeting.

get/meetings/{meetingId}

Path parameters

meetingIdstring required

meeting ID.

Query parameters

fieldsstring[]

Additional fields that should be populated.

  • hostRoomUrl - Include hostRoomUrl field in the meeting response.
  • viewerRoomUrl - Include viewerRoomUrl field in the meeting response.

Response

A JSON object representing the meeting.

meetingIdstring required

The ID of the meeting.

roomNamestring

The name of the room.

roomUrlstring uri required

The URL to room where the meeting will be hosted.

startDatestring date-time

When the meeting starts. Always in UTC, regardless of the input timezone.

endDatestring date-time required

When the meeting ends. Always in UTC, regardless of the input timezone.

hostRoomUrlstring uri

The URL to the room where the meeting will be hosted which will also make the user the host of the meeting. A host will get additional privileges like locking the room, and removing and muting participants, so you should be careful with whom you share this URL. The user will only become a host if the meeting is on-going (some additional slack is added to allow a host joining the meeting ahead of time or if the meeting goes over time). This field is optional and will only be returned if requested through the fields parameter.

viewerRoomUrlstring uri

The URL to the room where the meeting will be hosted which will make the user a viewer of the meeting. A viewer will not be able to turn on the camera or microphone, but will be able to join the meeting. This field is optional and will only be returned if requested through the fields parameter.

Example response

{
  "meetingId": "9cf691bf-f2d5-4420-bda9-ee8607bb558b",
  "startDate": "2025-05-12T16:42:49Z",
  "endDate": "2025-05-12T17:42:49Z",
  "roomUrl": "https://subdomain.whereby.com/room-prefix-793e9ec1-c686-423d-9043-9b7a10c553fd"
}