HubSpot · Schema

BatchResponseCompany

Results from a batch operation on companies.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
status string
results array
completedAt string
View JSON Schema on GitHub

JSON Schema

hubspot-crm-companies-batch-response-company-schema.json Raw ↑
{
  "type": "object",
  "description": "Results from a batch operation on companies.",
  "properties": {
    "status": {
      "type": "string",
      "example": "active"
    },
    "results": {
      "type": "array",
      "example": [
        {
          "id": "500123",
          "properties": {
            "key": "value"
          },
          "createdAt": "2025-03-15T14:30:00Z",
          "updatedAt": "2025-03-15T14:30:00Z",
          "archived": true,
          "associations": {
            "key": "value"
          }
        }
      ],
      "items": {
        "type": "object",
        "description": "A HubSpot company record.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier for the company.",
            "example": "500123"
          },
          "properties": {
            "type": "object",
            "description": "The company's properties as key-value pairs.",
            "example": {
              "key": "value"
            }
          },
          "createdAt": {
            "type": "string",
            "description": "The date and time the company was created.",
            "format": "date-time",
            "example": "2025-03-15T14:30:00Z"
          },
          "updatedAt": {
            "type": "string",
            "description": "The date and time the company was last updated.",
            "format": "date-time",
            "example": "2025-03-15T14:30:00Z"
          },
          "archived": {
            "type": "boolean",
            "description": "Whether the company has been archived.",
            "example": true
          },
          "associations": {
            "type": "object",
            "description": "The company's associations with other CRM objects.",
            "example": {
              "key": "value"
            }
          }
        }
      }
    },
    "completedAt": {
      "type": "string",
      "format": "date-time",
      "example": "2025-03-15T14:30:00Z"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BatchResponseCompany"
}