Skip to main content
GET
/
public
/
workspace
/
{workspaceId}
/
projects
List projects
curl --request GET \
  --url https://api.userplane.io/api/v1/public/workspace/{workspaceId}/projects \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "data": {
    "workspaceId": "<string>",
    "projects": [
      {
        "projectId": "<string>",
        "projectTitle": "<string>",
        "isDefault": true,
        "recordingRetentionDays": 0,
        "createdAt": "<unknown>",
        "updatedAt": "<unknown>"
      }
    ],
    "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 projects in the specified workspace.

​
Errors

Error codeStatusDescription
FORBIDDEN403Insufficient permissions
Also returns common authentication errors.

Get Project

Retrieve details for a specific project

List Links

Filter recording links by project

List Recordings

Filter recordings by project

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:5
required
Required range: 1 <= x <= 10
​
sort_by
enum<string>
default:created_at
required
Available options:
created_at,
project_title
​
sort_direction
enum<string>
default:desc
required
Available options:
asc,
desc

Response

OK

​
message
string
required
​
data
object
required