Get Project

Retrieve project details by ID

GET /public/workspace/{workspaceId}/projects/{projectId}

Get project

cURL

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

200

{
  "message": "<string>",
  "data": {
    "workspaceId": "<string>",
    "project": {
      "projectId": "<string>",
      "projectTitle": "<string>",
      "isDefault": true,
      "recordingRetentionDays": 0,
      "createdAt": "<unknown>",
      "updatedAt": "<unknown>"
    }
  }
}

Returns details for a specific project in the workspace.

Errors

Error code	Status	Description
PROJECT_NOT_FOUND	404	Project does not exist
PROJECT_GONE	410	Project has been deleted

Also returns common authentication errors.

Related

List Projects

Paginated list of all projects in a workspace

List Links

Recording links filtered by project

List Recordings

Recordings filtered by project

Get Workspace

Workspace details for this project

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

projectId · string · required

Minimum string length: 1

Response

200

application/json

OK

message · string · required

data · object · required

Show child attributes