Skip to main content
GET
/
public
/
workspaces
List workspaces
curl --request GET \
  --url https://api.userplane.com/api/v1/public/workspaces \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "data": {
    "workspaces": [
      {
        "workspaceId": "<string>",
        "workspaceName": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "workspaceMembership": {
          "workspaceMemberId": "<string>",
          "workspaceRole": "owner",
          "workspaceJoinedAt": "2023-11-07T05:31:56Z"
        }
      }
    ],
    "total": 1,
    "pagination": {
      "page": 1,
      "perPage": 1,
      "total": 1,
      "totalPages": 1,
      "hasMore": true
    }
  }
}
Returns a paginated list of workspaces the authenticated user belongs to.

Errors

This endpoint only returns common authentication errors.

Get Workspace

Retrieve details for a specific workspace

Get Current User

Your profile and aggregate stats

List Projects

Projects within a workspace

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

Query Parameters

page
integer
default:1
Required range: x >= 0
per_page
integer
default:10
Required range: 1 <= x <= 20
include_workspace_membership
boolean
default:false

Response

OK

message
string
required
data
object
required