Retrieve a list of workspace plan tasks with the Dock API

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
    }
  }
}

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

Show child attributes

filters.workspaceId

string

Filter workspace plan tasks by a workspace ID

Example:

"RiHO4e0Ju3DS"

filters.workspacePlanId

string

Filter workspace plan tasks by a workspace plan ID

Example:

"RiHO4e0Ju3DS"

filters.templatePlanTaskId

string

Filter workspace plan tasks by a template plan task ID

Example:

"RiHO4e0Ju3DS"

page

integer

Page number

limit

integer

Number of results to return

Response

Retrieve a list of workspace plan tasks

data

object

Show child attributes

data.workspacePlanTasks

object[]

Show child attributes

data.workspacePlanTasks.id

string

Id of the object

Example:

"RiHO4e0Ju3DS"

data.workspacePlanTasks.updatedAt

string<date-time>

Last updated date

Example:

"2021-01-01T00:00:00.000Z"

data.workspacePlanTasks.createdAt

string<date-time>

Created at date

Example:

"2021-01-01T00:00:00.000Z"

data.workspacePlanTasks.object

enum<string>

Type of the object

Available options:

workspacePlanTask

Example:

"workspacePlanTask"

data.workspacePlanTasks.url

string

URL to the resource

Example:

"https://api.dock.us/v1/workspace-plan-tasks/RiHO4e0Ju3DS"

data.workspacePlanTasks.isInternal

boolean

Whether the workspace plan task is internal

Example:

false

data.workspacePlanTasks.status

string

Status of the workspace plan task

Example:

"In Progress"

data.workspacePlanTasks.completedAt

string<date-time> | null

Completed at date of the workspace plan task

Example:

"2024-01-01T00:00:00Z"

data.workspacePlanTasks.actionLinkUrl

string | null

Action link URL of the workspace plan task

Example:

"https://acme.dock.us/onboarding"

data.workspacePlanTasks.actionLinkName

string | null

Action link name of the workspace plan task

Example:

"View onboarding plan"

data.workspacePlanTasks.actionText

string | null

Action text of the workspace plan task

Example:

"View onboarding plan"

data.workspacePlanTasks.actionType

enum<string> | null

Action type of the workspace plan task

Available options:

link,

fileDownload,

fileUpload,

form,

video,

calendar,

pdf,

embedAnything,

embedCode

Example:

"link"

data.workspacePlanTasks.showActionText

boolean

Whether to show action text of the workspace plan task

Example:

true

data.workspacePlanTasks.startDate

string<date> | null

Start date of the workspace plan task

Example:

"2024-01-01"

data.workspacePlanTasks.title

string | null

Title of the workspace plan task

Example:

"Create onboarding plan"

data.workspacePlanTasks.dueDate

string<date> | null

Due date of the workspace plan task

Example:

"2024-01-01"

data.workspacePlanTasks.index

integer | null

Index of the workspace plan task

Example:

0

data.workspacePlanTasks.templatePlanTaskId

string | null

ID of the associated template plan task

Example:

"RiHO4e0Ju3DS"

data.pageInfo

object

Show child attributes

data.pageInfo.page

integer

Current page number

Example:

1

data.pageInfo.pages

integer

Total number of pages

Example:

10

data.pageInfo.total

integer

Total number of items

Example:

100

data.pageInfo.pageTotal

integer

Number of items on the current page

Example:

10

data.pageInfo.hasNextPage

boolean

Whether there is a next page

Example:

true

data.pageInfo.hasPrevPage

boolean

Whether there is a previous page

Example:

false

Retrieve a workspace plan Retrieve a workspace plan task

⌘I

API Reference

Status Check

Accounts

Deals

Users

Templates

Workspaces

Workspace users

Workspace domains

Workspace pages

Workspace sections

Workspace plans

Workspace plan tasks

Custom fields

Assets

Tags

Boards

Retrieve a list of workspace plan tasks

Authorizations

Query Parameters

Response