Skip to main content
GET
/
public
/
workspace
/
{workspaceId}
/
recordings
List recordings
curl --request GET \
  --url https://api.userplane.com/api/v1/public/workspace/{workspaceId}/recordings \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "data": {
    "workspaceId": "<string>",
    "recordings": [
      {
        "recordingId": "<string>",
        "recordingThumbnail": "<string>",
        "recordingDurationMs": 123,
        "expiresAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "creator": {
          "workspaceMemberId": "<string>",
          "name": "<string>"
        },
        "linkTitle": "<string>"
      }
    ],
    "pagination": {
      "page": 1,
      "perPage": 1,
      "total": 1,
      "totalPages": 1,
      "hasMore": true
    }
  }
}
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 range: x >= 0
per_page
integer
default:10
Required range: 1 <= x <= 20
created_by
string[]
Minimum string length: 1
project_id
string[]
Minimum string length: 1
Minimum string length: 1
sort_by
enum<string>
default:created_at
Available options:
created_at,
recording_duration
sort_direction
enum<string>
default:desc
Available options:
asc,
desc

Response

OK

message
string
required
data
object
required