Skip to main content
GET
/
public
/
workspace
/
{workspaceId}
/
recordings
List recordings
curl --request GET \
  --url https://api.userplane.io/api/v1/public/workspace/{workspaceId}/recordings \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "data": {
    "workspaceId": "<string>",
    "recordings": [
      {
        "recordingId": "<string>",
        "recordingThumbnail": "<string>",
        "recordingDurationMs": 0,
        "expiresAt": null,
        "createdAt": "<unknown>",
        "creator": {
          "workspaceMemberId": "<string>",
          "name": "<string>"
        },
        "linkTitle": "<string>"
      }
    ],
    "pagination": {
      "page": 123,
      "perPage": 123,
      "total": 4503599627370495,
      "totalPages": 4503599627370495,
      "hasMore": true
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.userplane.io/llms.txt

Use this file to discover all available pages before exploring further.

Returns a paginated list of recordings in the specified workspace with optional filtering and sorting.

​
Errors

This endpoint returns common authentication errors.

Get Recording

Full recording details with metadata

Recording Resources

Download video, thumbnail, and log files

List Links

Links that generated these recordings

Pagination

Page-based pagination for list endpoints

Authorizations

​
Authorization
string
header
required

API key with uspl_ prefix. Create keys at dash.userplane.io/_/account?tab=developers

Path Parameters

​
workspaceId
string
required
Minimum string length: 1

Query Parameters

​
page
integer
default:1
required
Required range: x <= 9007199254740991
​
per_page
integer
default:10
required
Required range: 1 <= x <= 20
​
created_by
string[]
Minimum string length: 1
​
project_id
string[]
Minimum string length: 1
​
link_id
string[]
Minimum string length: 1
​
sort_by
enum<string>
default:created_at
required
Available options:
created_at,
recording_duration
​
sort_direction
enum<string>
default:desc
required
Available options:
asc,
desc

Response

OK

​
message
string
required
​
data
object
required