Skip to main content
GET
/
workspace-plans
cURL
curl --request GET \
  --url https://api.dock.us/{version}/workspace-plans \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "workspacePlans": [
      {
        "id": "RiHO4e0Ju3DS",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "object": "workspacePlan",
        "url": "https://api.dock.us/v1/workspace-plans/RiHO4e0Ju3DS",
        "title": "Onboarding",
        "isCollapsed": true,
        "viewType": "list"
      }
    ],
    "pageInfo": {
      "page": 1,
      "pages": 10,
      "total": 100,
      "pageTotal": 10,
      "hasNextPage": true,
      "hasPrevPage": false
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
properties
enum<string>[]

Select the workspace plan properties that should be returned

Available options:
title,
isCollapsed,
viewType,
createdAt,
updatedAt
​
filters
object

Filter workspace plans

​
page
integer

Page number

​
limit
integer

Number of results to return

Response

Retrieve a list of workspace plans

​
data
object