HubSpot · JSON Structure

Engagement Calls Api Batch Read Calls Request Structure

Request body for batch reading calls

Type: object Properties: 4 Required: 1
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

BatchReadCallsRequest is a JSON Structure definition published by HubSpot, describing 4 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

inputs properties propertiesWithHistory idProperty

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/engagement-calls-api-batch-read-calls-request-structure.json",
  "name": "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"
  ]
}