latestOpenAPI 3.0.02026-08-1027587.8 KB

3d9aec0774ff

Get recordings

Returns the recordings.

get/recordings

Query parameters

roomNamestring

The name of the room

cursorstring

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request.

Example:8f4031bfc7640c5f267b11b6fe0c2507

limitinteger

The limit for the pagination - the maximum number of results that will be returned within a single API response.

Sort results by a field. Accepted fields are: roomName, startDate, duration and sizeInMegaBytes. Accepted sort values are 'asc' and 'desc'.

Response

A JSON object with the page containing the array with the recordings results.

resultsRecording[] required

cursorstring required

The cursor for paginating through the results. To fetch the next page, set the cursor to the cursor returned by the previous request. If there are no more results, the value returned is null.

Example response

{
  "results": [
    {
      "recordingId": "a56f6ad7-37fe-4a37-9319-3174630ba57a",
      "roomSessionId": "e2f29530-46ec-4cee-8b27-e565cb5bb2e9",
      "filename": "recording.mp4",
      "startDate": "2025-01-01T00:00:00.000Z",
      "endDate": "2025-01-01T00:00:00.000Z",
      "sizeInMegaBytes": 100
    }
  ]
}