Get Workspace

Retrieve workspace details by ID

GET /public/workspace/{workspaceId}

Get workspace

cURL

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

200

{
  "message": "<string>",
  "data": {
    "workspace": {
      "workspaceId": "<string>",
      "workspaceName": "<string>",
      "createdAt": "<unknown>",
      "updatedAt": "<unknown>"
    }
  }
}

Returns details for a specific workspace. Requires the authenticated user to be an active member of the workspace.

Errors

Error code	Status	Description
WORKSPACE_NOT_FOUND	404	Workspace does not exist

Also returns common authentication errors.

Related

Get Invite URL

Retrieve the workspace invite URL

List Projects

Projects within this workspace

List Links

Recording links in this workspace

List Recordings

Recordings in this workspace

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

Response

200

application/json

OK

message · string · required

data · object · required

Show child attributes