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