HubSpot · Schema

BatchReadInput

Input for a batch read operation.

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
properties array The properties to return for each record.
inputs array The IDs of the records to read.
View JSON Schema on GitHub

JSON Schema

hubspot-crm-contacts-batch-read-input-schema.json Raw ↑
{
  "type": "object",
  "description": "Input for a batch read operation.",
  "properties": {
    "properties": {
      "type": "array",
      "description": "The properties to return for each record.",
      "example": [
        "example-value"
      ],
      "items": {
        "type": "string"
      }
    },
    "inputs": {
      "type": "array",
      "description": "The IDs of the records to read.",
      "example": [
        {
          "id": "500123"
        }
      ],
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          }
        }
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "BatchReadInput"
}