API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Retrieve a list of workspace plan tasks
Retrieve a list of 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
isInternal
, status
, completedAt
, actionLinkUrl
, actionLinkName
, actionText
, actionType
, showActionText
, startDate
, title
, dueDate
, index
, createdAt
, updatedAt
, templatePlanTaskId
Filter workspace plan tasks
Filter workspace plan tasks by a workspace ID
"RiHO4e0Ju3DS"
Filter workspace plan tasks by a workspace plan ID
"RiHO4e0Ju3DS"
Filter workspace plan tasks by a template plan task 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
workspacePlanTask
"workspacePlanTask"
URL to the resource
"https://api.dock.us/v1/workspace-plan-tasks/RiHO4e0Ju3DS"
Whether the workspace plan task is internal
false
Status of the workspace plan task
"In Progress"
Completed at date of the workspace plan task
"2024-01-01T00:00:00Z"
Action link URL of the workspace plan task
"https://acme.dock.us/onboarding"
Action link name of the workspace plan task
"View onboarding plan"
Action text of the workspace plan task
"View onboarding plan"
Action type of the workspace plan task
link
, fileDownload
, fileUpload
, form
, video
, calendar
, pdf
, embedAnything
, embedCode
"link"
Whether to show action text of the workspace plan task
true
Start date of the workspace plan task
"2024-01-01"
Title of the workspace plan task
"Create onboarding plan"
Due date of the workspace plan task
"2024-01-01"
Index of the workspace plan task
0
ID of the associated template plan task
"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-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
}
}
}