Skip to main content
GET
/
workspace-plans
/
{id}
cURL
curl --request GET \
  --url https://api.dock.us/{version}/workspace-plans/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "workspacePlan": {
      "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"
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Unique identifier

Example:

"RiHO4e0Ju3DS"

Query Parameters

​
properties
enum<string>[]

Select the workspace plan properties that should be returned

Available options:
title,
isCollapsed,
viewType,
createdAt,
updatedAt

Response

Retrieve a workspace plan by ID

​
data
object