Get Recording

Retrieve complete recording details

GET /public/workspace/{workspaceId}/recordings/{recordingId}

Get recording

cURL

curl --request GET \
  --url https://api.userplane.io/api/v1/public/workspace/{workspaceId}/recordings/{recordingId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.userplane.io/api/v1/public/workspace/{workspaceId}/recordings/{recordingId}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userplane.io/api/v1/public/workspace/{workspaceId}/recordings/{recordingId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.userplane.io/api/v1/public/workspace/{workspaceId}/recordings/{recordingId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.userplane.io/api/v1/public/workspace/{workspaceId}/recordings/{recordingId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.userplane.io/api/v1/public/workspace/{workspaceId}/recordings/{recordingId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.userplane.io/api/v1/public/workspace/{workspaceId}/recordings/{recordingId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "message": "<string>",
  "data": {
    "workspaceId": "<string>",
    "recording": {
      "recordingId": "<string>",
      "recordingDurationMs": 0,
      "recordingStartedAt": null,
      "meta": {
        "link": {
          "linkId": "<string>",
          "title": "<string>",
          "providerId": "<string>",
          "providerRef": "<string>",
          "providerData": "<unknown>",
          "createdAt": "<unknown>"
        },
        "creator": {
          "workspaceMemberId": "<string>",
          "name": "<string>"
        },
        "project": {
          "projectId": "<string>",
          "title": "<string>"
        },
        "domain": {
          "domainId": "<string>",
          "url": "<string>"
        },
        "workspaceId": "<string>",
        "systemMeta": {},
        "customMeta": {},
        "notes": "<string>",
        "expiresAt": null,
        "createdAt": "<unknown>",
        "updatedAt": "<unknown>"
      }
    }
  }
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Invalid request parameters. Check the request body and query parameters. See https://docs.userplane.io/api/error-handling",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "API key is required. Include it as Authorization: Bearer <your-api-key>. See https://docs.userplane.io/api/authentication",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "The API key is disabled. Enable it or create a new key. See https://docs.userplane.io/api/authentication",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Workspace not found",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Workspace has been deleted",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "Rate limit exceeded. Wait and retry with exponential backoff. See https://docs.userplane.io/api/rate-limits",
  "data": "<unknown>"
}

{
  "defined": "<unknown>",
  "code": "<unknown>",
  "status": "<unknown>",
  "message": "API key verification service is temporarily unavailable. Please try again later. See https://docs.userplane.io/api/error-handling",
  "data": "<unknown>"
}

Returns full details for a specific recording, including metadata about the link, creator, project, domain, and capture status.

Errors

Error code	Status	Description
RECORDING_NOT_FOUND	404	Recording does not exist
RECORDING_GONE	410	Recording has already been deleted

Also returns common authentication errors.

Related

Recording Resources

Download video, thumbnail, and log files

Delete Recording

Soft-delete this recording

List Recordings

View all recordings in the workspace

Get Link

Details for the link that captured this recording

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

recordingId · string · required

Minimum string length: 1

Response

200

application/json

OK

message · string · required

data · object · required

Show child attributes