HubSpot · Schema
BatchResponseCompany
Results from a batch operation on companies.
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales
Properties
| Name | Type | Description |
|---|---|---|
| status | string | |
| results | array | |
| completedAt | string |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/crm-companies-api-batch-response-company-schema.json",
"title": "BatchResponseCompany",
"description": "Results from a batch operation on companies.",
"type": "object",
"properties": {
"status": {
"type": "string",
"example": "active"
},
"results": {
"type": "array",
"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.",
"additionalProperties": {
"type": "string"
},
"example": {
"key": "value"
}
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "The date and time the company was created.",
"example": "2025-03-15T14:30:00Z"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "The date and time the company was last updated.",
"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.",
"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"
}
}
]
},
"completedAt": {
"type": "string",
"format": "date-time",
"example": "2025-03-15T14:30:00Z"
}
}
}