API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Create a workspace
Create a workspace
curl --request POST \
--url https://api.dock.so:4000/{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,
"magicLinkVerificationEnabled": false,
"welcomePageCta": "View Workspace",
"welcomePageText": "<string>"
}'
{
"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"
}
]
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Select the workspace properties that should be returned
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
ID of the template to use for the workspace
"1234567890"
ID of the HubSpot company to use for the workspace
"1234567890"
ID of the HubSpot deal to use for the workspace
"1234567890"
ID of the Salesforce account to use for the workspace
"1234567890"
ID of the Salesforce opportunity to use for the workspace
"1234567890"
ID of the account to use for the workspace
"1234567890"
Share setting for the workspace
landingPage
, withLink
, restricted
"landingPage"
Notify people for the workspace
Name of the workspace
"My Workspace"
Auto publish workspace
Google verification enabled
Magic link verification enabled
Welcome page CTA
Welcome page text
Response
Id of the object
"RiHO4e0Ju3DS"
Last updated date
"2021-01-01T00:00:00.000Z"
Created at date
"2021-01-01T00:00:00.000Z"
Users of the workspace
Id of the object
"RiHO4e0Ju3DS"
Last updated date
"2021-01-01T00:00:00.000Z"
Created at date
"2021-01-01T00:00:00.000Z"
Role of the user to access the workspace
owner
, editor
, collaborator
, viewer
, commenter
"owner"
Id of the object
"RiHO4e0Ju3DS"
Last updated date
"2021-01-01T00:00:00.000Z"
Created at date
"2021-01-01T00:00:00.000Z"
Type of the object
user
"user"
URL to the resource
"https://api.dock.us/v1/users/RiHO4e0Ju3DS"
First name of the user
"John"
Last name of the user
"Doe"
Avatar of the user
"https://dock.us/avatar.png"
Email of the user
"john.doe@example.com"
Name of the user
"John Doe"
Domains of the workspace
Id of the object
"RiHO4e0Ju3DS"
Last updated date
"2021-01-01T00:00:00.000Z"
Created at date
"2021-01-01T00:00:00.000Z"
Role of the user to access the workspace
owner
, editor
, collaborator
, viewer
, commenter
"owner"
Domain of the workspace user
"dock.us"
Id of the object
"RiHO4e0Ju3DS"
Last updated date
"2021-01-01T00:00:00.000Z"
Created at date
"2021-01-01T00:00:00.000Z"
Type of the object
account
"account"
URL to the resource
"https://api.dock.us/v1/accounts/RiHO4e0Ju3DS"
Name of the account
"Dock"
Website of the account
"https://dock.us"
Owner ID of the account
"RiHO4e0Ju3DS"
Logo of the account
"https://dock.us/logo.png"
Salesforce account ID of the account
"0015f00000Bg59dAAB"
HubSpot company ID of the account
"8662045446"
Type of the object
workspace
"workspace"
URL to the resource
"https://api.dock.us/v1/workspaces/RiHO4e0Ju3DS"
Name of the workspace
"Customer Onboarding"
URL of the workspace
"https://acme.dock.us/customer-onboarding-vRQgIvscHAiO"
ID of the associated template
"RiHO4e0Ju3DS"
Start date of the workspace
"2024-01-01"
Target end date of the workspace
"2024-01-01"
Actual end date of the workspace
"2024-01-01"
Age of the project
100
Progress of all the tasks
"50"
Last contact view date of the workspace
"2024-01-01T00:00:00Z"
Total views of the workspace
100
Total actions of the workspace
100
Total time spent of the workspace
100
Number of contacts associated with the workspace
100
Id of the object
"RiHO4e0Ju3DS"
Last updated date
"2021-01-01T00:00:00.000Z"
Created at date
"2021-01-01T00:00:00.000Z"
Type of the object
deal
"deal"
URL to the resource
"https://api.dock.us/v1/deals/RiHO4e0Ju3DS"
Created date of the deal
"2024-01-01T00:00:00Z"
Close date of the deal
"2024-01-01T00:00:00Z"
Name of the deal
"Deal 1"
Amount of the deal
"100000"
Type of the deal
"New Business"
Stage of the deal
"Proposal Sent"
HubSpot deal ID
"1234567890"
Custom fields associated with the workspace
Id of the object
"RiHO4e0Ju3DS"
Last updated date
"2021-01-01T00:00:00.000Z"
Created at date
"2021-01-01T00:00:00.000Z"
Type of the object
customField
"customField"
URL to the resource
"https://api.dock.us/v1/custom-fields/RiHO4e0Ju3DS"
Variable name of the custom field
"account.name"
Type of the custom field
number
, date
, singleLineText
, multiLineText
, singleCheckbox
, multiCheckboxes
, dropdownSelect
, radioSelect
"singleCheckbox"
Value of the custom field
"Yes"
curl --request POST \
--url https://api.dock.so:4000/{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,
"magicLinkVerificationEnabled": false,
"welcomePageCta": "View Workspace",
"welcomePageText": "<string>"
}'
{
"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"
}
]
}
}
}