Skip to main content
GET
/
public
/
workspace
/
{workspaceId}
/
links
List recording links
curl --request GET \
  --url https://api.userplane.io/api/v1/public/workspace/{workspaceId}/links \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "data": {
    "workspaceId": "<string>",
    "links": [
      {
        "linkId": "<string>",
        "linkTitle": "<string>",
        "linkReusable": true,
        "linkProviderId": "<string>",
        "linkProviderReference": "<string>",
        "linkURL": "<string>",
        "linkMeta": {},
        "createdAt": "<unknown>",
        "project": {
          "projectId": "<string>",
          "title": "<string>"
        },
        "creator": {
          "workspaceMemberId": "<string>",
          "name": "<string>"
        },
        "domain": {
          "domainId": "<string>",
          "url": "<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 recording links in the specified workspace with optional filtering and sorting.

​
Errors

This endpoint returns common authentication errors.

Create Link

Create a new recording link

Get Link

Retrieve details for a specific link

List Recordings

Filter recordings by link ID

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
​
domain_id
string[]
Minimum string length: 1
​
link_provider_type
enum<string>[]
Available options:
intercom,
zendesk,
hubspot,
freshdesk,
freshchat,
jira_service_management,
helpscout,
happyfox,
ada,
forethought,
servicenow,
front,
zoho_desk,
crisp,
pylon,
plain,
asana,
azure_devops,
clickup,
github,
gitlab,
jira,
linear,
notion,
sentry,
slack,
web,
others
​
link_type
enum<string>
Available options:
file,
recording,
session,
screenshot
​
sort_by
enum<string>
default:created_at
required
Available options:
created_at,
link_title
​
sort_direction
enum<string>
default:desc
required
Available options:
asc,
desc

Response

OK

​
message
string
required
​
data
object
required