HubSpot · JSON Structure

Crm Deals Api Deal Structure

A HubSpot deal record.

Type: object Properties: 6
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Deal is a JSON Structure definition published by HubSpot, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id properties createdAt updatedAt archived associations

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/crm-deals-api-deal-structure.json",
  "name": "Deal",
  "description": "A HubSpot deal record.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for the deal.",
      "example": "500123"
    },
    "properties": {
      "type": "object",
      "description": "The deal's properties as key-value pairs.",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value"
      }
    },
    "createdAt": {
      "type": "datetime",
      "description": "The date and time the deal was created.",
      "example": "2025-03-15T14:30:00Z"
    },
    "updatedAt": {
      "type": "datetime",
      "description": "The date and time the deal was last updated.",
      "example": "2025-03-15T14:30:00Z"
    },
    "archived": {
      "type": "boolean",
      "description": "Whether the deal has been archived.",
      "example": true
    },
    "associations": {
      "type": "object",
      "description": "The deal's associations with other CRM objects.",
      "additionalProperties": {
        "type": "object",
        "description": "A list of associations.",
        "properties": {
          "results": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Association"
            },
            "example": [
              {
                "id": "500123",
                "type": "standard"
              }
            ]
          },
          "paging": {
            "$ref": "#/components/schemas/Paging"
          }
        }
      },
      "example": {
        "key": "value"
      }
    }
  }
}