API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Retrieve a list of workspace pages
Retrieve a list of workspace pages
curl --request GET \
--url https://api.dock.so:4000/{version}/workspace-pages \
--header 'Authorization: Bearer <token>'
{
"data": {
"workspacePages": [
{
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"object": "workspacePage",
"url": "https://api.dock.us/v1/workspace-pages/RiHO4e0Ju3DS",
"name": "Planning",
"navigationName": "Home",
"isHidden": false,
"index": 0,
"templatePageId": "RiHO4e0Ju3DS"
}
],
"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 page properties that should be returned
name
, navigationName
, isHidden
, index
, createdAt
, updatedAt
, templatePageId
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
workspacePage
"workspacePage"
URL to the resource
"https://api.dock.us/v1/workspace-pages/RiHO4e0Ju3DS"
Name of the workspace page
"Planning"
Navigation name of the workspace page
"Home"
Whether the workspace page is hidden
false
Index of the workspace page
0
ID of the associated template page
"RiHO4e0Ju3DS"
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-pages \
--header 'Authorization: Bearer <token>'
{
"data": {
"workspacePages": [
{
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"object": "workspacePage",
"url": "https://api.dock.us/v1/workspace-pages/RiHO4e0Ju3DS",
"name": "Planning",
"navigationName": "Home",
"isHidden": false,
"index": 0,
"templatePageId": "RiHO4e0Ju3DS"
}
],
"pageInfo": {
"page": 1,
"pages": 10,
"total": 100,
"pageTotal": 10,
"hasNextPage": true,
"hasPrevPage": false
}
}
}