Whether you are using Dock’s API or not, this page is a quick way to understand how Dock’s data is structured. When interacting with Dock’s API, you’ll also need to create an API key to authenticate your requests.

​
Account

Account represents any external relationships, typically another company. The most common use case for an Account is your customer or sales prospect. Integration with external systems like Salesforce and HubSpot allows for seamless synchronization of account data, enhancing the management of client relationships and related business processes. All the accounts are associated with a company that can be accessed via the API. An account can also be created, updated via the API.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: account
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
name
string
The name of the account.
​
website
string | null
The website of the account.
​
ownerId
string | null
The ID of the user who owns the account.
The logo of the account.
​
salesforceAccountId
string | null
The ID of the Salesforce account.
​
hubspotCompanyId
string | null
The ID of the Hubspot company.

​
Deal

Deals are a way to track and manage your sales pipeline. If you have a CRM integration, you can sync your deals(HubSpot deals, Salesforce opportunities, etc.) with Dock.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: deal
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
name
string | null
The name of the deal.
​
hubspotDealId
string | null
The Hubspot deal ID (when deal is from Hubspot).
​
salesforceOpportunityId
string | null
The Salesforce opportunity ID (when deal is from Salesforce).
​
amount
number | null
Monetary value of the deal.
​
closeDate
string | null
Expected or actual closing date of the deal.
Example format: “2021-01-01T00:00:00.000Z”
​
createdDate
string | null
Date when the deal was created in the source system.
Example format: “2021-01-01T00:00:00.000Z”
​
stage
string | null
Current stage of the deal.
​
type
string | null
Type of the deal.

​
User

User represents an individual who interacts with the Dock platform. Each user can be associated with a company, create or manage workspaces, and perform various tasks within the system. Users have roles, permissions, and can participate in collaborations, making them key actors in the product’s ecosystem.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: user
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
firstName
string | null
The first name of the user.
​
lastName
string | null
The last name of the user.
​
avatar
string | null
The avatar of the user.
​
email
string
The email of the user.
​
name
string
The name of the user.

​
Template

Template represents a pre-defined group of pages & sections. Templates can be turned into Workspaces. Templates are a powerful way to build scalable processes across the organization. As your team members start to create their own Workspaces, templates can help them save time configuring and ultimately help ensure that everyone is following a similar framework. Read more about templates.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: template
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
types
enum<string>[] | null
The types of the template.
Available options: sales, implementation, renewal, portal, project, internal
​
title
string | null
The title of the template.
​
slackChannelEnabled
boolean
default:"true"
Whether a Slack channel is enabled for the template.
​
messagesEnabled
boolean
default:"true"
Whether messages are enabled for the template.
​
stagesEnabled
boolean
default:"true"
Whether stages are enabled for the template.

​
Workspace

Workspaces are a shared space between your organization and an external organization. Since they are built on a flexible editor, they can be used for a variety of cases. You can create a workspace with a template too. Workspaces can be managed with the Workspaces API. Read more about workspaces.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: workspace
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
name
string
The name of the workspace.
​
workspaceUrl
string
The URL of the workspace.
​
templateId
string | null
The ID of the template.
​
startDate
string | null
The start date of the workspace.
Example format: 2024-01-01
​
targetEndDate
string | null
The target end date of the workspace.
Example format: 2024-01-01
​
actualEndDate
string | null
The actual end date of the workspace.
Example format: 2024-01-01
​
projectAge
number
The age of the project.
​
taskProgress
string
The progress of the task.
​
lastClientView
string
The last client view of the workspace.
Example format: 2024-01-01T00:00:00Z
​
totalViews
number
The total views of the workspace.
​
totalActions
number
The total actions of the workspace.
​
totalTimeSpent
number
The total time spent of the workspace.
​
clientsPerWorkspace
number
The number of clients per workspace.
​
account
object | null
The account associated with the workspace.
​
workspaceDomains
object[]
Workspace domains associated with the workspace.
​
workspaceUsers
object[]
Workspace users associated with the workspace.
​
deal
object | null
The deal associated with the workspace.

​
Workspace user

Workspace users are users who are associated with a workspace.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: workspaceUser
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
role
enum<string>
The role of the user in the workspace.
Available options: owner, editor, collaborator, viewer, commenter
​
user
object[]
The user associated with the workspace user.

​
Workspace domain

Workspace domains are domains that are associated with a workspace.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: workspaceDomain
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
domain
string
The domain name in the email addresses that are associated with this workspace.
​
role
enum<string>
The role of the user in the workspace.
Available options: owner, editor, collaborator, viewer, commenter

​
Workspace page

Workspaces can be composed of multiple pages to help you organize your content. Each tab at the top of a workspace is a page. Workspace pages can be ordered, hidden, and have custom names. This allows you to organize your workspace in a way that makes sense for your team. Read more about workspace pages.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: workspacePage
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
name
string | null
The name of the workspace page.
​
navigationName
string | null
The navigation name of the workspace page.
​
hidden
boolean
default:"false"
Whether the workspace page is hidden.
​
index
number
default:"0"
The index of the workspace page.

​
Workspace section

Workspace pages are made up of a collection of Workspace Sections. Sections contain text, PDFs, images, links, widgets, and embeds. Sections are the building blocks of a workspace. Read more about workspace sections.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: workspaceSection
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
name
string | null
The name of the workspace section.
​
navigationName
string | null
The navigation name of the workspace section.
​
hidden
boolean
default:"false"
Whether the workspace section is hidden.
​
index
number
default:"1"
The index of the workspace section.
​
synced
boolean
default:"false"
Whether the workspace section is synced.
​
isCollaborative
boolean
default:"false"
Whether the workspace section is collaborative.
​
hideFromNavigation
boolean
Whether the workspace section is hidden from navigation.

​
Workspace plan

Workspace plan is a project plan that organizes a group of tasks. Dock enables you to collaborate hands-on with customers and prospects through mutual action plans. You can customize Checklists, Timelines and Kanbans to help ensure you’re moving that customer relationship forward. You can also using them internally within a Workspace, to make sure you’re aligned with your team on your to-do’s! Read more about workspace plans.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: workspacePlan
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
status
string
default:"No status"
The status of the workspace plan.
​
title
string | null
The title of the workspace plan.
​
collaborate
boolean
default:"true"
Whether the workspace plan allows collaboration.
​
collapse
boolean
default:"false"
Whether the workspace plan allows collapse.
​
viewType
enum<string>
The view type of the workspace plan.
Available options: list, card

​
Workspace plan task

Workspace plan tasks represent an action item. These checklists are composed of tasks and can be helpful in assigning out responsibilities or tracking a “to-do” list of sorts. They are highly customizable — you can assign ownership, update the status of that item, and add a due date that sends out notifications automatically. Tasks include assignees, due dates, start dates, action buttons, descriptions, and comments. Read more about workspace plan tasks.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: workspacePlanTask
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
isInternal
boolean
default:"false"
Whether the task is internal.
​
status
string
default:"No status"
The status of the task.
​
completedAt
string | null
The date and time when the task was completed.
Example format: 2024-02-20T12:00:00Z
​
actionLinkUrl
string | null
The URL of the action link.
​
actionLinkName
string | null
The name of the action link.
​
actionText
string | null
The text of the action.
​
actionType
enum<string> | null
The type of the action.
​
showActionText
boolean
default:"true"
Whether the action text is shown.
​
startDate
string | null
The start date of the task.
Example format: 2024-01-01
​
title
string | null
The title of the task.
​
dueDate
string | null
The due date of the task.
Example format: 2024-01-01
​
index
number | null
The index of the task.

​
Custom field

Custom fields are a way to add custom data to your deals, accounts, and workspaces.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: customField
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
name
string
The name of the custom field.
​
variableName
string
The variable name of the custom field.
​
type
enum<string>
The type of the custom field.
Available options: number, date, singleLineText, multiLineText, singleCheckbox, multiCheckboxes, dropdownSelect, radioSelect
​
options
object[] | null
The options of the custom field.

​
Asset

Assets are typically a piece of content (PDFs, links, images, or videos). Assets are found in Dock’s content library and can be tagged. Read more about assets.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: asset
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
object
enum<string>
required
The type of the resource.
Available options: asset
​
name
string
The name of the asset.
​
description
string | null
The description of the asset.
​
views
number
default:"0"
The number of views of the asset.
​
shares
number
default:"0"
The number of shares of the asset.
​
assetType
enum<string>
required
The type of the asset.
Available options: image, pdf, link, video
​
assetUrl
string
The URL of the asset.
​
tags
object[]
The tags associated with the asset.

​
Tag

Dock’s content library organizes your assets with a two-level system— Boards & Tags. Tags are categories for assets that live under the boards. For example, you might have a tags. called, “Integrations.” If you searched for that tags., the system will show all content assets with that tags. You can create and manage tags with the Tags API. Read more about Content management.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: tag
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
title
string
The title of the tag.
​
boards
object[]
The boards associated with the tag.

​
Board

Dock’s content library organizes your assets with a two-level system— Boards & Tags. Boards are internal folders. They are internal pages that organize or group a number of tags. You can create and manage boards with the Boards API. Read more about Content management.
​
id
string
required
The unique ID of the resource.
​
url
string
required
The URL of the resource.
​
object
enum
required
The type of the resource.
Available options: board
​
createdAt
string
The date and time when the resource was created.
Example format: "2021-01-01T00:00:00.000Z"
​
updatedAt
string
The date and time when the resource was last updated.
Example format: "2021-01-01T00:00:00.000Z"
​
title
string
The title of the board.
​
description
string | null
The description of the board.
​
appearance
enum<string>
The appearance of the board.
Available options: greyExtraLight, mandy, saffron, conifer, pastelGreen, downy, malibu, royalBlue, mediumPurple, brilliantRose
​
icon
string | null
The icon of the board.
​
tags
object[]
The collections of the board.