HubSpot · Schema
BatchReadCallsRequest
Request body for batch reading calls
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales
Properties
| Name | Type | Description |
|---|---|---|
| inputs | array | Array of call identifiers |
| properties | array | Properties to return |
| propertiesWithHistory | array | Properties to return with history |
| idProperty | string | The property to use as the identifier |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/engagement-calls-api-batch-read-calls-request-schema.json",
"title": "BatchReadCallsRequest",
"description": "Request body for batch reading calls",
"type": "object",
"properties": {
"inputs": {
"type": "array",
"description": "Array of call identifiers",
"items": {
"type": "object",
"description": "Input for reading a single item in a batch",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"description": "The call identifier",
"example": "512"
}
}
},
"maxItems": 100,
"example": [
{
"id": "512"
}
]
},
"properties": {
"type": "array",
"description": "Properties to return",
"items": {
"type": "string"
},
"example": [
"example-value"
]
},
"propertiesWithHistory": {
"type": "array",
"description": "Properties to return with history",
"items": {
"type": "string"
},
"example": [
"example-value"
]
},
"idProperty": {
"type": "string",
"description": "The property to use as the identifier",
"example": "500123"
}
},
"required": [
"inputs"
]
}