Skip to main content
GET
List all recordings
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
required

API key. Refer to Authentication for more information.

Accept
enum<string>
default:application/json
required

Must be application/json.

Available options:
application/json

Query Parameters

page_number
integer

Page of results to retrieve, starting from 1. Defaults to 1 when omitted.

page_size
integer

Number of results per page. Defaults to 30 when omitted.

owner_email
string

Only recordings owned by the member with this email address. Send me for the signed-in member, which works only with a CLI session. An unknown email returns an empty list.

from_date
string

Only recordings created on or after this date, in YYYY-MM-DD or YYYY-MM format, evaluated in UTC.

to_date
string

Only recordings created on or before this date, in YYYY-MM-DD or YYYY-MM format, evaluated in UTC.

folder_id
string

Only recordings in this folder. Accepts the folder id from the folders API.

tag_names[]
string[]

Only recordings carrying at least one of these tags. Repeat the parameter for each tag.

title
string

Only recordings whose title or default title contains this text.

has_transcript
boolean

true for only recordings with a transcript, false for only recordings without one.

requested_only
boolean
default:false

List only recordings created from a recording request.

sort_by
enum<string>
default:created_at

Field to sort by: created_at, title, duration, view_count. Defaults to created_at.

Available options:
created_at,
title,
duration,
view_count
sort_direction
enum<string>
default:desc

Sort direction: asc or desc. Defaults to desc.

Available options:
asc,
desc

Response

Successfully retrieved recordings.

recordings
object[]

List of recordings.

pagination
object