Create a workspace with the Dock API

cURL

curl --request POST \
  --url https://api.dock.us/{version}/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templateId": "1234567890",
  "hubspotCompanyId": "1234567890",
  "hubspotDealId": "1234567890",
  "salesforceAccountId": "1234567890",
  "salesforceOpportunityId": "1234567890",
  "accountId": "1234567890",
  "shareSetting": "landingPage",
  "notifyPeople": false,
  "workspaceUsers": [
    {
      "email": "jsmith@example.com",
      "role": "owner"
    }
  ],
  "workspaceDomains": [
    {
      "domain": "<string>",
      "role": "owner"
    }
  ],
  "name": "My Workspace",
  "autoPublishWorkspace": false,
  "googleVerificationEnabled": false,
  "microsoftVerificationEnabled": false,
  "magicLinkVerificationEnabled": false,
  "welcomePageCta": "View Workspace",
  "welcomePageText": "<string>",
  "startDate": "2025-06-15",
  "actualEndDate": "2025-09-30",
  "targetEndDate": "2025-08-31"
}
'

import requests

url = "https://api.dock.us/{version}/workspaces"

payload = {
    "templateId": "1234567890",
    "hubspotCompanyId": "1234567890",
    "hubspotDealId": "1234567890",
    "salesforceAccountId": "1234567890",
    "salesforceOpportunityId": "1234567890",
    "accountId": "1234567890",
    "shareSetting": "landingPage",
    "notifyPeople": False,
    "workspaceUsers": [
        {
            "email": "jsmith@example.com",
            "role": "owner"
        }
    ],
    "workspaceDomains": [
        {
            "domain": "<string>",
            "role": "owner"
        }
    ],
    "name": "My Workspace",
    "autoPublishWorkspace": False,
    "googleVerificationEnabled": False,
    "microsoftVerificationEnabled": False,
    "magicLinkVerificationEnabled": False,
    "welcomePageCta": "View Workspace",
    "welcomePageText": "<string>",
    "startDate": "2025-06-15",
    "actualEndDate": "2025-09-30",
    "targetEndDate": "2025-08-31"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    templateId: '1234567890',
    hubspotCompanyId: '1234567890',
    hubspotDealId: '1234567890',
    salesforceAccountId: '1234567890',
    salesforceOpportunityId: '1234567890',
    accountId: '1234567890',
    shareSetting: 'landingPage',
    notifyPeople: false,
    workspaceUsers: [{email: 'jsmith@example.com', role: 'owner'}],
    workspaceDomains: [{domain: '<string>', role: 'owner'}],
    name: 'My Workspace',
    autoPublishWorkspace: false,
    googleVerificationEnabled: false,
    microsoftVerificationEnabled: false,
    magicLinkVerificationEnabled: false,
    welcomePageCta: 'View Workspace',
    welcomePageText: '<string>',
    startDate: '2025-06-15',
    actualEndDate: '2025-09-30',
    targetEndDate: '2025-08-31'
  })
};

fetch('https://api.dock.us/{version}/workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dock.us/{version}/workspaces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'templateId' => '1234567890',
    'hubspotCompanyId' => '1234567890',
    'hubspotDealId' => '1234567890',
    'salesforceAccountId' => '1234567890',
    'salesforceOpportunityId' => '1234567890',
    'accountId' => '1234567890',
    'shareSetting' => 'landingPage',
    'notifyPeople' => false,
    'workspaceUsers' => [
        [
                'email' => 'jsmith@example.com',
                'role' => 'owner'
        ]
    ],
    'workspaceDomains' => [
        [
                'domain' => '<string>',
                'role' => 'owner'
        ]
    ],
    'name' => 'My Workspace',
    'autoPublishWorkspace' => false,
    'googleVerificationEnabled' => false,
    'microsoftVerificationEnabled' => false,
    'magicLinkVerificationEnabled' => false,
    'welcomePageCta' => 'View Workspace',
    'welcomePageText' => '<string>',
    'startDate' => '2025-06-15',
    'actualEndDate' => '2025-09-30',
    'targetEndDate' => '2025-08-31'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dock.us/{version}/workspaces"

	payload := strings.NewReader("{\n  \"templateId\": \"1234567890\",\n  \"hubspotCompanyId\": \"1234567890\",\n  \"hubspotDealId\": \"1234567890\",\n  \"salesforceAccountId\": \"1234567890\",\n  \"salesforceOpportunityId\": \"1234567890\",\n  \"accountId\": \"1234567890\",\n  \"shareSetting\": \"landingPage\",\n  \"notifyPeople\": false,\n  \"workspaceUsers\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"role\": \"owner\"\n    }\n  ],\n  \"workspaceDomains\": [\n    {\n      \"domain\": \"<string>\",\n      \"role\": \"owner\"\n    }\n  ],\n  \"name\": \"My Workspace\",\n  \"autoPublishWorkspace\": false,\n  \"googleVerificationEnabled\": false,\n  \"microsoftVerificationEnabled\": false,\n  \"magicLinkVerificationEnabled\": false,\n  \"welcomePageCta\": \"View Workspace\",\n  \"welcomePageText\": \"<string>\",\n  \"startDate\": \"2025-06-15\",\n  \"actualEndDate\": \"2025-09-30\",\n  \"targetEndDate\": \"2025-08-31\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dock.us/{version}/workspaces")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"templateId\": \"1234567890\",\n  \"hubspotCompanyId\": \"1234567890\",\n  \"hubspotDealId\": \"1234567890\",\n  \"salesforceAccountId\": \"1234567890\",\n  \"salesforceOpportunityId\": \"1234567890\",\n  \"accountId\": \"1234567890\",\n  \"shareSetting\": \"landingPage\",\n  \"notifyPeople\": false,\n  \"workspaceUsers\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"role\": \"owner\"\n    }\n  ],\n  \"workspaceDomains\": [\n    {\n      \"domain\": \"<string>\",\n      \"role\": \"owner\"\n    }\n  ],\n  \"name\": \"My Workspace\",\n  \"autoPublishWorkspace\": false,\n  \"googleVerificationEnabled\": false,\n  \"microsoftVerificationEnabled\": false,\n  \"magicLinkVerificationEnabled\": false,\n  \"welcomePageCta\": \"View Workspace\",\n  \"welcomePageText\": \"<string>\",\n  \"startDate\": \"2025-06-15\",\n  \"actualEndDate\": \"2025-09-30\",\n  \"targetEndDate\": \"2025-08-31\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dock.us/{version}/workspaces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"templateId\": \"1234567890\",\n  \"hubspotCompanyId\": \"1234567890\",\n  \"hubspotDealId\": \"1234567890\",\n  \"salesforceAccountId\": \"1234567890\",\n  \"salesforceOpportunityId\": \"1234567890\",\n  \"accountId\": \"1234567890\",\n  \"shareSetting\": \"landingPage\",\n  \"notifyPeople\": false,\n  \"workspaceUsers\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"role\": \"owner\"\n    }\n  ],\n  \"workspaceDomains\": [\n    {\n      \"domain\": \"<string>\",\n      \"role\": \"owner\"\n    }\n  ],\n  \"name\": \"My Workspace\",\n  \"autoPublishWorkspace\": false,\n  \"googleVerificationEnabled\": false,\n  \"microsoftVerificationEnabled\": false,\n  \"magicLinkVerificationEnabled\": false,\n  \"welcomePageCta\": \"View Workspace\",\n  \"welcomePageText\": \"<string>\",\n  \"startDate\": \"2025-06-15\",\n  \"actualEndDate\": \"2025-09-30\",\n  \"targetEndDate\": \"2025-08-31\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "workspace": {
      "id": "RiHO4e0Ju3DS",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "workspaceUsers": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "role": "owner",
          "user": {
            "id": "RiHO4e0Ju3DS",
            "updatedAt": "2021-01-01T00:00:00.000Z",
            "createdAt": "2021-01-01T00:00:00.000Z",
            "object": "user",
            "url": "https://api.dock.us/v1/users/RiHO4e0Ju3DS",
            "firstName": "John",
            "lastName": "Doe",
            "avatar": "https://dock.us/avatar.png",
            "email": "john.doe@example.com",
            "name": "John Doe"
          }
        }
      ],
      "workspaceDomains": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "role": "owner",
          "domain": "dock.us"
        }
      ],
      "account": {
        "id": "RiHO4e0Ju3DS",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "object": "account",
        "url": "https://api.dock.us/v1/accounts/RiHO4e0Ju3DS",
        "name": "Dock",
        "website": "https://dock.us",
        "ownerId": "RiHO4e0Ju3DS",
        "logo": "https://dock.us/logo.png",
        "salesforceAccountId": "0015f00000Bg59dAAB",
        "hubspotCompanyId": "8662045446"
      },
      "object": "workspace",
      "url": "https://api.dock.us/v1/workspaces/RiHO4e0Ju3DS",
      "name": "Customer Onboarding",
      "workspaceUrl": "https://acme.dock.us/customer-onboarding-vRQgIvscHAiO",
      "templateId": "RiHO4e0Ju3DS",
      "startDate": "2024-01-01",
      "targetEndDate": "2024-01-01",
      "actualEndDate": "2024-01-01",
      "projectAge": 100,
      "taskProgress": "50",
      "lastContactView": "2024-01-01T00:00:00Z",
      "totalViews": 100,
      "totalActions": 100,
      "totalTimeSpent": 100,
      "contactsCount": 100,
      "deal": {
        "id": "RiHO4e0Ju3DS",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "hubspotDealId": "1234567890",
        "object": "deal",
        "url": "https://api.dock.us/v1/deals/RiHO4e0Ju3DS",
        "createdDate": "2024-01-01T00:00:00Z",
        "closeDate": "2024-01-01T00:00:00Z",
        "name": "Deal 1",
        "amount": "100000",
        "type": "New Business",
        "stage": "Proposal Sent"
      },
      "customFields": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "object": "customField",
          "url": "https://api.dock.us/v1/custom-fields/RiHO4e0Ju3DS",
          "variableName": "account.name",
          "type": "singleCheckbox",
          "options": [
            {
              "index": 1,
              "label": "Yes",
              "value": "true"
            }
          ],
          "value": "Yes"
        }
      ]
    }
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request could not be understood or was missing required parameters"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Access denied. You are not authorized to access this resource"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Access to this resource is restricted"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested resource could not be found"
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "The server has encountered a situation it does not know how to handle"
  }
}

POST

workspaces

cURL

curl --request POST \
  --url https://api.dock.us/{version}/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "templateId": "1234567890",
  "hubspotCompanyId": "1234567890",
  "hubspotDealId": "1234567890",
  "salesforceAccountId": "1234567890",
  "salesforceOpportunityId": "1234567890",
  "accountId": "1234567890",
  "shareSetting": "landingPage",
  "notifyPeople": false,
  "workspaceUsers": [
    {
      "email": "jsmith@example.com",
      "role": "owner"
    }
  ],
  "workspaceDomains": [
    {
      "domain": "<string>",
      "role": "owner"
    }
  ],
  "name": "My Workspace",
  "autoPublishWorkspace": false,
  "googleVerificationEnabled": false,
  "microsoftVerificationEnabled": false,
  "magicLinkVerificationEnabled": false,
  "welcomePageCta": "View Workspace",
  "welcomePageText": "<string>",
  "startDate": "2025-06-15",
  "actualEndDate": "2025-09-30",
  "targetEndDate": "2025-08-31"
}
'

import requests

url = "https://api.dock.us/{version}/workspaces"

payload = {
    "templateId": "1234567890",
    "hubspotCompanyId": "1234567890",
    "hubspotDealId": "1234567890",
    "salesforceAccountId": "1234567890",
    "salesforceOpportunityId": "1234567890",
    "accountId": "1234567890",
    "shareSetting": "landingPage",
    "notifyPeople": False,
    "workspaceUsers": [
        {
            "email": "jsmith@example.com",
            "role": "owner"
        }
    ],
    "workspaceDomains": [
        {
            "domain": "<string>",
            "role": "owner"
        }
    ],
    "name": "My Workspace",
    "autoPublishWorkspace": False,
    "googleVerificationEnabled": False,
    "microsoftVerificationEnabled": False,
    "magicLinkVerificationEnabled": False,
    "welcomePageCta": "View Workspace",
    "welcomePageText": "<string>",
    "startDate": "2025-06-15",
    "actualEndDate": "2025-09-30",
    "targetEndDate": "2025-08-31"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    templateId: '1234567890',
    hubspotCompanyId: '1234567890',
    hubspotDealId: '1234567890',
    salesforceAccountId: '1234567890',
    salesforceOpportunityId: '1234567890',
    accountId: '1234567890',
    shareSetting: 'landingPage',
    notifyPeople: false,
    workspaceUsers: [{email: 'jsmith@example.com', role: 'owner'}],
    workspaceDomains: [{domain: '<string>', role: 'owner'}],
    name: 'My Workspace',
    autoPublishWorkspace: false,
    googleVerificationEnabled: false,
    microsoftVerificationEnabled: false,
    magicLinkVerificationEnabled: false,
    welcomePageCta: 'View Workspace',
    welcomePageText: '<string>',
    startDate: '2025-06-15',
    actualEndDate: '2025-09-30',
    targetEndDate: '2025-08-31'
  })
};

fetch('https://api.dock.us/{version}/workspaces', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dock.us/{version}/workspaces",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'templateId' => '1234567890',
    'hubspotCompanyId' => '1234567890',
    'hubspotDealId' => '1234567890',
    'salesforceAccountId' => '1234567890',
    'salesforceOpportunityId' => '1234567890',
    'accountId' => '1234567890',
    'shareSetting' => 'landingPage',
    'notifyPeople' => false,
    'workspaceUsers' => [
        [
                'email' => 'jsmith@example.com',
                'role' => 'owner'
        ]
    ],
    'workspaceDomains' => [
        [
                'domain' => '<string>',
                'role' => 'owner'
        ]
    ],
    'name' => 'My Workspace',
    'autoPublishWorkspace' => false,
    'googleVerificationEnabled' => false,
    'microsoftVerificationEnabled' => false,
    'magicLinkVerificationEnabled' => false,
    'welcomePageCta' => 'View Workspace',
    'welcomePageText' => '<string>',
    'startDate' => '2025-06-15',
    'actualEndDate' => '2025-09-30',
    'targetEndDate' => '2025-08-31'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dock.us/{version}/workspaces"

	payload := strings.NewReader("{\n  \"templateId\": \"1234567890\",\n  \"hubspotCompanyId\": \"1234567890\",\n  \"hubspotDealId\": \"1234567890\",\n  \"salesforceAccountId\": \"1234567890\",\n  \"salesforceOpportunityId\": \"1234567890\",\n  \"accountId\": \"1234567890\",\n  \"shareSetting\": \"landingPage\",\n  \"notifyPeople\": false,\n  \"workspaceUsers\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"role\": \"owner\"\n    }\n  ],\n  \"workspaceDomains\": [\n    {\n      \"domain\": \"<string>\",\n      \"role\": \"owner\"\n    }\n  ],\n  \"name\": \"My Workspace\",\n  \"autoPublishWorkspace\": false,\n  \"googleVerificationEnabled\": false,\n  \"microsoftVerificationEnabled\": false,\n  \"magicLinkVerificationEnabled\": false,\n  \"welcomePageCta\": \"View Workspace\",\n  \"welcomePageText\": \"<string>\",\n  \"startDate\": \"2025-06-15\",\n  \"actualEndDate\": \"2025-09-30\",\n  \"targetEndDate\": \"2025-08-31\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dock.us/{version}/workspaces")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"templateId\": \"1234567890\",\n  \"hubspotCompanyId\": \"1234567890\",\n  \"hubspotDealId\": \"1234567890\",\n  \"salesforceAccountId\": \"1234567890\",\n  \"salesforceOpportunityId\": \"1234567890\",\n  \"accountId\": \"1234567890\",\n  \"shareSetting\": \"landingPage\",\n  \"notifyPeople\": false,\n  \"workspaceUsers\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"role\": \"owner\"\n    }\n  ],\n  \"workspaceDomains\": [\n    {\n      \"domain\": \"<string>\",\n      \"role\": \"owner\"\n    }\n  ],\n  \"name\": \"My Workspace\",\n  \"autoPublishWorkspace\": false,\n  \"googleVerificationEnabled\": false,\n  \"microsoftVerificationEnabled\": false,\n  \"magicLinkVerificationEnabled\": false,\n  \"welcomePageCta\": \"View Workspace\",\n  \"welcomePageText\": \"<string>\",\n  \"startDate\": \"2025-06-15\",\n  \"actualEndDate\": \"2025-09-30\",\n  \"targetEndDate\": \"2025-08-31\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dock.us/{version}/workspaces")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"templateId\": \"1234567890\",\n  \"hubspotCompanyId\": \"1234567890\",\n  \"hubspotDealId\": \"1234567890\",\n  \"salesforceAccountId\": \"1234567890\",\n  \"salesforceOpportunityId\": \"1234567890\",\n  \"accountId\": \"1234567890\",\n  \"shareSetting\": \"landingPage\",\n  \"notifyPeople\": false,\n  \"workspaceUsers\": [\n    {\n      \"email\": \"jsmith@example.com\",\n      \"role\": \"owner\"\n    }\n  ],\n  \"workspaceDomains\": [\n    {\n      \"domain\": \"<string>\",\n      \"role\": \"owner\"\n    }\n  ],\n  \"name\": \"My Workspace\",\n  \"autoPublishWorkspace\": false,\n  \"googleVerificationEnabled\": false,\n  \"microsoftVerificationEnabled\": false,\n  \"magicLinkVerificationEnabled\": false,\n  \"welcomePageCta\": \"View Workspace\",\n  \"welcomePageText\": \"<string>\",\n  \"startDate\": \"2025-06-15\",\n  \"actualEndDate\": \"2025-09-30\",\n  \"targetEndDate\": \"2025-08-31\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "workspace": {
      "id": "RiHO4e0Ju3DS",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "workspaceUsers": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "role": "owner",
          "user": {
            "id": "RiHO4e0Ju3DS",
            "updatedAt": "2021-01-01T00:00:00.000Z",
            "createdAt": "2021-01-01T00:00:00.000Z",
            "object": "user",
            "url": "https://api.dock.us/v1/users/RiHO4e0Ju3DS",
            "firstName": "John",
            "lastName": "Doe",
            "avatar": "https://dock.us/avatar.png",
            "email": "john.doe@example.com",
            "name": "John Doe"
          }
        }
      ],
      "workspaceDomains": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "role": "owner",
          "domain": "dock.us"
        }
      ],
      "account": {
        "id": "RiHO4e0Ju3DS",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "object": "account",
        "url": "https://api.dock.us/v1/accounts/RiHO4e0Ju3DS",
        "name": "Dock",
        "website": "https://dock.us",
        "ownerId": "RiHO4e0Ju3DS",
        "logo": "https://dock.us/logo.png",
        "salesforceAccountId": "0015f00000Bg59dAAB",
        "hubspotCompanyId": "8662045446"
      },
      "object": "workspace",
      "url": "https://api.dock.us/v1/workspaces/RiHO4e0Ju3DS",
      "name": "Customer Onboarding",
      "workspaceUrl": "https://acme.dock.us/customer-onboarding-vRQgIvscHAiO",
      "templateId": "RiHO4e0Ju3DS",
      "startDate": "2024-01-01",
      "targetEndDate": "2024-01-01",
      "actualEndDate": "2024-01-01",
      "projectAge": 100,
      "taskProgress": "50",
      "lastContactView": "2024-01-01T00:00:00Z",
      "totalViews": 100,
      "totalActions": 100,
      "totalTimeSpent": 100,
      "contactsCount": 100,
      "deal": {
        "id": "RiHO4e0Ju3DS",
        "updatedAt": "2021-01-01T00:00:00.000Z",
        "createdAt": "2021-01-01T00:00:00.000Z",
        "hubspotDealId": "1234567890",
        "object": "deal",
        "url": "https://api.dock.us/v1/deals/RiHO4e0Ju3DS",
        "createdDate": "2024-01-01T00:00:00Z",
        "closeDate": "2024-01-01T00:00:00Z",
        "name": "Deal 1",
        "amount": "100000",
        "type": "New Business",
        "stage": "Proposal Sent"
      },
      "customFields": [
        {
          "id": "RiHO4e0Ju3DS",
          "updatedAt": "2021-01-01T00:00:00.000Z",
          "createdAt": "2021-01-01T00:00:00.000Z",
          "object": "customField",
          "url": "https://api.dock.us/v1/custom-fields/RiHO4e0Ju3DS",
          "variableName": "account.name",
          "type": "singleCheckbox",
          "options": [
            {
              "index": 1,
              "label": "Yes",
              "value": "true"
            }
          ],
          "value": "Yes"
        }
      ]
    }
  }
}

{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request could not be understood or was missing required parameters"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Access denied. You are not authorized to access this resource"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Access to this resource is restricted"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested resource could not be found"
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Please try again later"
  }
}

{
  "error": {
    "code": "INTERNAL_SERVER_ERROR",
    "message": "The server has encountered a situation it does not know how to handle"
  }
}

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 properties that should be returned

Available options:

accountId,

name,

workspaceUrl,

templateId,

startDate,

targetEndDate,

actualEndDate,

projectAge,

taskProgress,

lastContactView,

totalViews,

totalActions,

totalTimeSpent,

contactsCount,

account.name,

account.website,

account.ownerId,

account.logo,

account.salesforceAccountId,

account.hubspotCompanyId,

account.createdAt,

account.updatedAt,

customFields.name,

customFields.type,

customFields.variableName,

customFields.value,

workspaceDomains.domain,

workspaceDomains.role,

workspaceDomains.createdAt,

workspaceDomains.updatedAt,

workspaceUsers.role,

workspaceUsers.createdAt,

workspaceUsers.updatedAt,

workspaceUsers.user.firstName,

workspaceUsers.user.lastName,

workspaceUsers.user.avatar,

workspaceUsers.user.email,

workspaceUsers.user.name,

workspaceUsers.user.createdAt,

workspaceUsers.user.updatedAt,

deal.name,

deal.amount,

deal.closeDate,

deal.createdDate,

deal.type,

deal.stage,

deal.hubspotDealId,

deal.salesforceOpportunityId

Body

application/json

templateId

string

ID of the template to use for the workspace

Example:

"1234567890"

hubspotCompanyId

string

ID of the HubSpot company to use for the workspace

Example:

"1234567890"

hubspotDealId

string

ID of the HubSpot deal to use for the workspace

Example:

"1234567890"

salesforceAccountId

string

ID of the Salesforce account to use for the workspace

Example:

"1234567890"

salesforceOpportunityId

string

ID of the Salesforce opportunity to use for the workspace

Example:

"1234567890"

accountId

string

ID of the account to use for the workspace

Example:

"1234567890"

Share setting for the workspace

Available options:

landingPage,

withLink,

restricted

Example:

"landingPage"

notifyPeople

boolean

default:false

Notify people for the workspace

workspaceUsers

object[]

Users to access the workspace

Show child attributes

workspaceDomains

object[]

Domains to access the workspace

Show child attributes

name

string

Name of the workspace

Example:

"My Workspace"

autoPublishWorkspace

boolean

default:false

Auto publish workspace

googleVerificationEnabled

boolean

default:false

Google verification enabled

microsoftVerificationEnabled

boolean

default:false

Microsoft verification enabled

magicLinkVerificationEnabled

boolean

default:false

Magic link verification enabled

welcomePageCta

string

default:View Workspace

Welcome page CTA

welcomePageText

string

Welcome page text

startDate

string<date> | null

The start date of the workspace in YYYY-MM-DD format, or null to remove the date

Example:

"2025-06-15"

actualEndDate

string<date> | null

The actual end date of the workspace in YYYY-MM-DD format, or null to remove the date

Example:

"2025-09-30"

targetEndDate

string<date> | null

The target end date of the workspace in YYYY-MM-DD format, or null to remove the date

Example:

"2025-08-31"

Response

Workspace created

data

object

Show child attributes

Retrieve a workspace Set workspace access