const express = require('express');
const app = express();
const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./api-reference/openapi.json');

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

app.listen(3001, () => {
  console.log('Server is running on port 3001');
});


Check if the API is up

Ping the API

Dock

Dock organizes everything shared with customers in one branded workspace. Create deal rooms, onboarding hubs, and client portals that customers love.

Getting Started with Dock API - Documentation

Introduction

A quick overview of how Dock's data model is structured.

Data model

A quick overview of how to embed Dock's workspace in your app.

Embedding workspace

Dock API Reference - Introduction

How to get my Dock API key?

API Keys

What are Dock's API rate limits?

Rate limits

Learn how to paginate through resources in the API.

All endpoints that list resources support pagination.

Pagination

Troubleshoot problems with this comprehensive breakdown of all error codes.

Dock's API returns machine readable error codes, human readable error messages and a link to the docs for more information

Errors

Retrieve a list of accounts with the Dock API - API Reference

Retrieve a list of accounts

Create an account with the Dock API - API Reference

Create an account

Retrieve an account with the Dock API - API Reference

Retrieve an account

Update an account by ID. Currently this endpoint only supports updating workspace custom field values.

Update an account with the Dock API - API Reference

Update an account

Retrieve a list of deals with the Dock API - API Reference

Retrieve a list of deals

Retrieve a deal with the Dock API - API Reference

Retrieve a deal

Update a deal by ID. Currently this endpoint only supports updating deal custom field values.

Update a deal with the Dock API - API Reference

Update a deal

Retrieve a list of users with the Dock API - API Reference

Retrieve a list of users

Retrieve an user with the Dock API - API Reference

Retrieve a user

Retrieve a list of templates with the Dock API - API Reference

Retrieve a list of templates

Retrieve a template with the Dock API - API Reference

Retrieve a template

Retrieve a list of workspaces with the Dock API - API Reference

Retrieve a list of workspaces

Retrieve a workspace with the Dock API - API Reference

Retrieve a workspace

Create a workspace with the Dock API - API Reference

Create a workspace

Set workspace access with the Dock API - API Reference

Set workspace access

Update a workspace with the Dock API - API Reference

Update a workspace

Get an authenticated embed url for a user with the Dock API - API Reference

Get an authenticated embed url

Retrieve a workspace user with the Dock API - API Reference

Retrieve a workspace user

Retrieve a list of workspace users with the Dock API - API Reference

Retrieve a list of workspace users

Update a workspace user with the Dock API - API Reference

Update a workspace user

Delete a workspace user with the Dock API - API Reference

Delete a workspace user

Create a workspace user with the Dock API - API Reference

Create a workspace user

Retrieve a workspace domain with the Dock API - API Reference

Retrieve a workspace domain

Retrieve a list of workspace domains with the Dock API - API Reference

Retrieve a list of workspace domains

Delete a workspace domain with the Dock API - API Reference

Delete a workspace domain

Create a workspace domain with the Dock API - API Reference

Create a workspace domain

Update a workspace domain with the Dock API - API Reference

Update a workspace domain

Retrieve a list of workspace pages with the Dock API - API Reference

Retrieve a list of workspace pages

Retrieve a workspace page with the Dock API - API Reference

Retrieve a workspace page

Update a workspace page with the Dock API - API Reference

Update a workspace page

Retrieve a list of workspace sections with the Dock API - API Reference

Retrieve a list of workspace sections

Retrieve a workspace section with the Dock API - API Reference

Retrieve a workspace section

Update a workspace section with the Dock API - API Reference

Update a workspace section

Retrieve a list of workspace plans with the Dock API - API Reference

Retrieve a list of workspace plans

Retrieve a workspace plan with the Dock API - API Reference

Retrieve a workspace plan

Retrieve a list of workspace plan tasks with the Dock API - API Reference

Retrieve a list of workspace plan tasks

Retrieve a workspace plan task with the Dock API - API Reference

Retrieve a workspace plan task

Update a workspace plan task with the Dock API - API Reference

Update a workspace plan task

Retrieve a list of custom fields with the Dock API - API Reference

Retrieve a list of custom fields

Retrieve a custom field with the Dock API - API Reference

Retrieve a custom field

Retrieve a list of assets with the Dock API - API Reference

Retrieve a list of assets

Retrieve an asset with the Dock API - API Reference

Retrieve an asset

Update an asset with the Dock API - API Reference

Update an asset

Delete an asset with the Dock API - API Reference

Delete an asset

Retrieve a list of tags with the Dock API - API Reference

Retrieve a list of tags

Retrieve a tag with the Dock API - API Reference

Retrieve a tag

Create a tag with the Dock API - API Reference

Create a tag

Update a tag with the Dock API - API Reference

Update a tag

Delete a tag with the Dock API - API Reference

Delete a tag

Retrieve a list of boards with the Dock API - API Reference

Retrieve a list of boards

Retrieve a board

Create a board with the Dock API - API Reference

Create a board

Update a board with the Dock API - API Reference

Update a board

Delete a board with the Dock API - API Reference

Delete a board

Use webhooks to get real-time notifications on events happening across your Dock workspace.

Dock Webhook Reference - Introduction

Create a subscription to receive real-time notifications on events happening across your Dock workspace.

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

Ping the API

Response