Skip to main content
GET
/
deals
cURL
curl --request GET \
  --url https://api.dock.us/{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
    }
  }
}

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.

Query Parameters

​
page
integer

Page number

​
limit
integer

Number of results to return

​
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

List of deals

​
data
object