Documentation
Recordings

List recordings (paginated with filters)

GET
/api/v1/recordings

Authorization

tenant-api-key
x-api-key<token>

Tenant API key (backend only — never expose to a browser)

In: header

Query Parameters

page?number
Range1 <= value
Default1
limit?number
Range1 <= value <= 100
Default20
roomId?string

Filter by room ID

status?string

Filter by recording status

Value in

  • "STARTING"
  • "ACTIVE"
  • "ENDING"
  • "PROCESSING"
  • "COMPLETED"
  • "FAILED"
type?string

Filter by recording type

Value in

  • "ROOM_COMPOSITE"
  • "TRACK_COMPOSITE"
  • "TRACK"
  • "AUDIO_ONLY"
  • "WEB"
  • "PARTICIPANT"

Response Body

curl -X GET "https://example.com/api/v1/recordings"
Empty

Delete a recording and its storage file DELETE

Previous Page

Get a recording by ID GET

Next Page