API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Retrieve a list of workspace plans
Retrieve a list of workspace plans
curl --request GET \
--url https://api.dock.so:4000/{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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Select the workspace plan properties that should be returned
title
, isCollapsed
, viewType
, createdAt
, updatedAt
Filter workspace plans
Filter workspace plans by a workspace ID
"RiHO4e0Ju3DS"
Page number
Number of results to return
Response
Id of the object
"RiHO4e0Ju3DS"
Last updated date
"2021-01-01T00:00:00.000Z"
Created at date
"2021-01-01T00:00:00.000Z"
Type of the object
workspacePlan
"workspacePlan"
URL to the resource
"https://api.dock.us/v1/workspace-plans/RiHO4e0Ju3DS"
Title of the workspace plan
"Onboarding"
Whether the workspace plan is by default collapsed
true
View type of the workspace plan
list
, card
"list"
Current page number
1
Total number of pages
10
Total number of items
100
Number of items on the current page
10
Whether there is a next page
true
Whether there is a previous page
false
curl --request GET \
--url https://api.dock.so:4000/{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
}
}
}