Skip to main content
GET
/
workspace-plan-tasks
cURL
curl --request GET \
  --url https://api.dock.us/{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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
properties
enum<string>[]

Select the workspace plan task properties that should be returned

Available options:
isInternal,
status,
completedAt,
actionLinkUrl,
actionLinkName,
actionText,
actionType,
showActionText,
startDate,
title,
dueDate,
index,
createdAt,
updatedAt,
templatePlanTaskId
​
filters
object

Filter workspace plan tasks

​
page
integer

Page number

​
limit
integer

Number of results to return

Response

Retrieve a list of workspace plan tasks

​
data
object