API Reference
Status Check
Accounts
Workspaces
Workspace users
Workspace domains
Workspace pages
Workspace sections
Workspace plan tasks
Retrieve a list of deals
Retrieve a list of deals
curl --request GET \
--url https://api.dock.so:4000/{version}/deals \
--header 'Authorization: Bearer <token>'
{
"data": {
"deals": [
{
"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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Page number
Number of results to return
Select the deal properties that should be returned
hubspotDealId
, salesforceOpportunityId
, name
, amount
, closeDate
, createdDate
, stage
, type
, customFields.name
, customFields.type
, customFields.variableName
, customFields.value
, createdAt
, updatedAt
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
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"
Custom fields associated with the deal
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"
HubSpot deal ID
"1234567890"
Current page number
1
Total number of pages
10
Total number of items
100
Number of items on the current page
10
Whether there is a next page
true
Whether there is a previous page
false
curl --request GET \
--url https://api.dock.so:4000/{version}/deals \
--header 'Authorization: Bearer <token>'
{
"data": {
"deals": [
{
"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
}
}
}