Getting Started
Data model
A quick overview of how Dock’s data model is structured.
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.Account model
Account model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
accountThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The name of the account.
The website of the account.
The ID of the user who owns the account.
The logo of the account.
The ID of the Salesforce account.
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.Deal model
Deal model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
dealThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The name of the deal.
The Hubspot deal ID (when deal is from Hubspot).
The Salesforce opportunity ID (when deal is from Salesforce).
Monetary value of the deal.
Expected or actual closing date of the deal.
Example format:
“2021-01-01T00:00:00.000Z”Date when the deal was created in the source system.
Example format:
“2021-01-01T00:00:00.000Z”Current stage of the deal.
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.User model
User model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
userThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The first name of the user.
The last name of the user.
The avatar of the user.
The email of the user.
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.Template model
Template model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
templateThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The types of the template.
Available options:
sales, implementation, renewal, portal, project, internalThe title of the template.
Whether a Slack channel is enabled for the template.
Whether messages are enabled for the template.
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.Workspace model
Workspace model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
workspaceThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The name of the workspace.
The URL of the workspace.
The ID of the template.
The start date of the workspace.
Example format:
2024-01-01The target end date of the workspace.
Example format:
2024-01-01The actual end date of the workspace.
Example format:
2024-01-01The age of the project.
The progress of the task.
The last client view of the workspace.
Example format:
2024-01-01T00:00:00ZThe total views of the workspace.
The total actions of the workspace.
The total time spent of the workspace.
The number of clients per workspace.
The account associated with the workspace.
Workspace domains associated with the workspace.
Workspace users associated with the workspace.
The deal associated with the workspace.
Workspace user
Workspace users are users who are associated with a workspace.Workspace user model
Workspace user model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
workspaceUserThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The role of the user in the workspace.
Available options:
owner, editor, collaborator, viewer, commenterThe user associated with the workspace user.
Workspace domain
Workspace domains are domains that are associated with a workspace.Workspace domain model
Workspace domain model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
workspaceDomainThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The domain name in the email addresses that are associated with this
workspace.
The role of the user in the workspace.
Available options:
owner, editor, collaborator, viewer, commenterWorkspace 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.Workspace page model
Workspace page model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
workspacePageThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The name of the workspace page.
The navigation name of the workspace page.
Whether the workspace page is hidden.
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.Workspace section model
Workspace section model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
workspaceSectionThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The name of the workspace section.
The navigation name of the workspace section.
Whether the workspace section is hidden.
The index of the workspace section.
Whether the workspace section is synced.
Whether the workspace section is collaborative.
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.Workspace plan model
Workspace plan model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
workspacePlanThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The status of the workspace plan.
The title of the workspace plan.
Whether the workspace plan allows collaboration.
Whether the workspace plan allows collapse.
The view type of the workspace plan.
Available options:
list, cardWorkspace 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.Workspace plan task model
Workspace plan task model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
workspacePlanTaskThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"Whether the task is internal.
The status of the task.
The date and time when the task was completed.
Example format:
2024-02-20T12:00:00ZThe URL of the action link.
The name of the action link.
The text of the action.
The type of the action.
Whether the action text is shown.
The start date of the task.
Example format:
2024-01-01The title of the task.
The due date of the task.
Example format:
2024-01-01The index of the task.
Custom field
Custom fields are a way to add custom data to your deals, accounts, and workspaces.Custom field model
Custom field model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
customFieldThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The name of the custom field.
The variable name of the custom field.
The type of the custom field.
Available options:
number, date, singleLineText, multiLineText, singleCheckbox, multiCheckboxes, dropdownSelect, radioSelectThe 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.Asset model
Asset model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
assetThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The type of the resource.
Available options:
assetThe name of the asset.
The description of the asset.
The number of views of the asset.
The number of shares of the asset.
The type of the asset.
Available options:
image, pdf, link, videoThe URL of the asset.
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.Tag model
Tag model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
tagThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The title of the tag.
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.Board model
Board model
The unique ID of the resource.
The URL of the resource.
The type of the resource.
Available options:
boardThe date and time when the resource was created.
Example format:
"2021-01-01T00:00:00.000Z"The date and time when the resource was last updated.
Example format:
"2021-01-01T00:00:00.000Z"The title of the board.
The description of the board.
The appearance of the board.
Available options:
greyExtraLight, mandy, saffron, conifer, pastelGreen, downy, malibu, royalBlue, mediumPurple, brilliantRoseThe icon of the board.
The collections of the board.