API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Create an account
Create an account
curl --request POST \
--url https://api.dock.so:4000/{version}/accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Dock",
"website": "https://dock.us",
"ownerId": "RiHO4e0Ju3DS",
"logo": "https://dock.us/logo.png"
}'
{
"data": {
"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",
"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 account properties that should be returned
name
, website
, ownerId
, logo
, salesforceAccountId
, hubspotCompanyId
, createdAt
, updatedAt
, customFields.name
, customFields.type
, customFields.variableName
, customFields.value
Body
Name of the account
1
"Dock"
Website of the account
"https://dock.us"
Owner ID of the account
"RiHO4e0Ju3DS"
Logo url of the account
"https://dock.us/logo.png"
Response
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"
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}/accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Dock",
"website": "https://dock.us",
"ownerId": "RiHO4e0Ju3DS",
"logo": "https://dock.us/logo.png"
}'
{
"data": {
"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",
"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"
}
]
}
}
}