HubSpot · Schema

CollectionResponseDeal

A paginated list of deal records.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
results array
paging object Pagination information.
View JSON Schema on GitHub

JSON Schema

crm-deals-api-collection-response-deal-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/crm-deals-api-collection-response-deal-schema.json",
  "title": "CollectionResponseDeal",
  "description": "A paginated list of deal records.",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A HubSpot deal record.",
        "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": "string",
            "format": "date-time",
            "description": "The date and time the deal was created.",
            "example": "2025-03-15T14:30:00Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "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": {
              "$ref": "#/components/schemas/CollectionResponseAssociation"
            },
            "example": {
              "key": "value"
            }
          }
        }
      },
      "example": [
        {
          "id": "500123",
          "properties": {
            "key": "value"
          },
          "createdAt": "2025-03-15T14:30:00Z",
          "updatedAt": "2025-03-15T14:30:00Z",
          "archived": true,
          "associations": {
            "key": "value"
          }
        }
      ]
    },
    "paging": {
      "type": "object",
      "description": "Pagination information.",
      "properties": {
        "next": {
          "type": "object",
          "properties": {
            "after": {
              "type": "string"
            }
          },
          "example": {
            "after": "example-value"
          }
        }
      }
    }
  }
}