API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Workspace plan tasks
Retrieve a list of workspace plan tasks
Retrieve a list of workspace plan tasks
GET
/
workspace-plan-tasks
curl --request GET \
--url https://api.dock.so:4000/{version}/workspace-plan-tasks \
--header 'Authorization: Bearer <token>'
{
"data": {
"workspacePlanTasks": [
{
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"object": "workspacePlanTask",
"url": "https://api.dock.us/v1/workspace-plan-tasks/RiHO4e0Ju3DS",
"isInternal": false,
"status": "In Progress",
"completedAt": "2024-01-01T00:00:00Z",
"actionLinkUrl": "https://acme.dock.us/onboarding",
"actionLinkName": "View onboarding plan",
"actionText": "View onboarding plan",
"actionType": "link",
"showActionText": true,
"startDate": "2024-01-01",
"title": "Create onboarding plan",
"dueDate": "2024-01-01",
"index": 0,
"templatePlanTaskId": "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 plan task properties that should be returned
Filter workspace plan tasks
Page number
Number of results to return
Response
200
application/json
Retrieve a list of workspace plan tasks
The response is of type object
.
curl --request GET \
--url https://api.dock.so:4000/{version}/workspace-plan-tasks \
--header 'Authorization: Bearer <token>'
{
"data": {
"workspacePlanTasks": [
{
"id": "RiHO4e0Ju3DS",
"updatedAt": "2021-01-01T00:00:00.000Z",
"createdAt": "2021-01-01T00:00:00.000Z",
"object": "workspacePlanTask",
"url": "https://api.dock.us/v1/workspace-plan-tasks/RiHO4e0Ju3DS",
"isInternal": false,
"status": "In Progress",
"completedAt": "2024-01-01T00:00:00Z",
"actionLinkUrl": "https://acme.dock.us/onboarding",
"actionLinkName": "View onboarding plan",
"actionText": "View onboarding plan",
"actionType": "link",
"showActionText": true,
"startDate": "2024-01-01",
"title": "Create onboarding plan",
"dueDate": "2024-01-01",
"index": 0,
"templatePlanTaskId": "RiHO4e0Ju3DS"
}
],
"pageInfo": {
"page": 1,
"pages": 10,
"total": 100,
"pageTotal": 10,
"hasNextPage": true,
"hasPrevPage": false
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.