Skip to main content
GET
/
workspaces
cURL
curl --request GET \
  --url https://api.dock.us/{version}/workspaces \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "workspaces": [
      {
        "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": "[email protected]",
              "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"
          }
        ]
      }
    ],
    "pageInfo": {
      "page": 1,
      "pages": 10,
      "total": 100,
      "pageTotal": 10,
      "hasNextPage": true,
      "hasPrevPage": false
    }
  }
}

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
​
filters
object

Filter the workspaces

​
page
integer

Page number

​
limit
integer

Number of results to return

Response

Retrieve a list of workspaces

​
data
object