Skip to main content
GET
/
deals
/
{id}
cURL
curl --request GET \
  --url https://api.dock.us/{version}/deals/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "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"
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.dock.us/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Unique identifier

Example:

"RiHO4e0Ju3DS"

Query Parameters

​
properties
enum<string>[]

Select the deal properties that should be returned

Available options:
hubspotDealId,
salesforceOpportunityId,
name,
amount,
closeDate,
createdDate,
stage,
type,
customFields.name,
customFields.type,
customFields.variableName,
customFields.value,
createdAt,
updatedAt

Response

Retrieve a deal by ID

​
data
object