HUhubspot
Batch

Retrieve multiple custom object schemas in a batch request.

Changed on

Retrieve details of multiple custom object schemas by providing a batch request with specified inputs. This operation allows you to fetch schema information, including properties and associations, for multiple custom objects in a single API call.

post/crm-object-schemas/2026-03/schemas/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm-object-schemas/2026-03/schemas/batch/read
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Request body

includeAssociationDefinitionsboolean required

Indicates whether to include association definitions in the response.

includeAuditMetadataboolean required

Indicates whether to include audit metadata in the response.

includePropertyDefinitionsboolean required

Indicates whether to include property definitions in the response.

inputsstring[] required

Response

successful operation

Changes

  • b0d8bc008db9Revision changes
    • info

      api operation id post-/crm-object-schemas/2026-03/schemas/batch/read_/crm-object-schemas/v3/schemas/batch/read removed and replaced with post-/crm-object-schemas/2026-03/schemas/batch/read

    • info

      the security scope crm.objects.custom.read was added to the endpoint's security scheme private_apps

    • info

      the security scope oauth was removed from the endpoint's security scheme private_apps

  • 3578967e48dfRevision changes
    • info

      the security scope crm.objects.custom.read was added to the endpoint's security scheme private_apps

    • info

      the security scope oauth was removed from the endpoint's security scheme private_apps

    • info

      added the optional property //// to the response with the status

Some revisions have not been checked yet.