HubSpot · Schema

BatchReadResponse

Response from a batch read operation

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationSales

Properties

Name	Type	Description
status	string	The status of the batch operation
results	array	The retrieved commerce payments
requestedAt	string	When the request was received
startedAt	string	When processing started
completedAt	string	When processing completed
numErrors	integer	Number of errors encountered
errors	array	List of errors
links	object

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/commerce-payments-api-batch-read-response-schema.json",
  "title": "BatchReadResponse",
  "description": "Response from a batch read operation",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ],
      "description": "The status of the batch operation",
      "example": "PENDING"
    },
    "results": {
      "type": "array",
      "description": "The retrieved commerce payments",
      "items": {
        "type": "object",
        "description": "A commerce payment object representing a payment transaction",
        "required": [
          "id",
          "properties",
          "createdAt",
          "updatedAt"
        ],
        "properties": {
          "id": {
            "type": "string",
            "description": "The unique identifier of the commerce payment",
            "example": "500123"
          },
          "properties": {
            "type": "object",
            "description": "The properties of the commerce payment",
            "additionalProperties": {
              "type": "string"
            },
            "example": {
              "key": "value"
            }
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the commerce payment was created",
            "example": "2025-03-15T14:30:00Z"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the commerce payment was last updated",
            "example": "2025-03-15T14:30:00Z"
          },
          "archived": {
            "type": "boolean",
            "description": "Whether the commerce payment is archived",
            "example": true
          },
          "archivedAt": {
            "type": "string",
            "format": "date-time",
            "description": "When the commerce payment was archived",
            "example": "2025-03-15T14:30:00Z"
          },
          "associations": {
            "type": "object",
            "description": "Associated objects",
            "additionalProperties": {
              "$ref": "#/components/schemas/AssociationResult"
            },
            "example": {
              "key": "value"
            }
          },
          "propertiesWithHistory": {
            "type": "object",
            "description": "Properties with their value history",
            "additionalProperties": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/PropertyHistory"
              }
            },
            "example": {
              "key": "value"
            }
          }
        }
      },
      "example": [
        {
          "id": "500123",
          "properties": {
            "key": "value"
          },
          "createdAt": "2025-03-15T14:30:00Z",
          "updatedAt": "2025-03-15T14:30:00Z",
          "archived": true,
          "archivedAt": "2025-03-15T14:30:00Z",
          "associations": {
            "key": "value"
          },
          "propertiesWithHistory": {
            "key": "value"
          }
        }
      ]
    },
    "requestedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When the request was received",
      "example": "2025-03-15T14:30:00Z"
    },
    "startedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When processing started",
      "example": "2025-03-15T14:30:00Z"
    },
    "completedAt": {
      "type": "string",
      "format": "date-time",
      "description": "When processing completed",
      "example": "2025-03-15T14:30:00Z"
    },
    "numErrors": {
      "type": "integer",
      "description": "Number of errors encountered",
      "example": 100
    },
    "errors": {
      "type": "array",
      "description": "List of errors",
      "items": {
        "type": "object",
        "description": "An error from a batch operation",
        "required": [
          "category",
          "message"
        ],
        "properties": {
          "status": {
            "type": "string",
            "example": "active"
          },
          "id": {
            "type": "string",
            "example": "500123"
          },
          "category": {
            "type": "string",
            "example": "standard"
          },
          "message": {
            "type": "string",
            "example": "This is an example description."
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ErrorDetail"
            },
            "example": [
              {
                "message": "This is an example description.",
                "code": "example-value",
                "in": "example-value",
                "subCategory": "standard",
                "context": {
                  "key": "value"
                }
              }
            ]
          },
          "context": {
            "type": "object",
            "additionalProperties": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": {
              "key": "value"
            }
          },
          "links": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "example": {
              "key": "value"
            }
          },
          "subCategory": {
            "type": "string",
            "example": "standard"
          }
        }
      },
      "example": [
        {
          "status": "active",
          "id": "500123",
          "category": "standard",
          "message": "This is an example description.",
          "errors": [
            {}
          ],
          "context": {
            "key": "value"
          },
          "links": {
            "key": "value"
          },
          "subCategory": "standard"
        }
      ]
    },
    "links": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "key": "value"
      }
    }
  },
  "required": [
    "status",
    "results",
    "startedAt",
    "completedAt"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools

Call it yourself

curl for this page

This JSON Schema

curl "https://apis.io/api/v1/json-schemas/commerce-payments-api-batch-read-response"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.