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-09/schemas/batch/read

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm-object-schemas/2026-09/schemas/batch/read
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.schemas.custom.read
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.custom.sensitive.read.v2
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.custom.read
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.objects.custom.highly_sensitive.read.v2

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

An array of strings representing the identifiers of the object schemas to be read.

Response

successful operation

Changes

  • 2026-0974d7720767a9Revision changes
    • info

      the security scope crm.schemas.custom.read was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.objects.custom.read was removed from the endpoint's security scheme oauth2

  • 2026-09793daeebe0edRevision changes
    • info

      the security scope crm.schemas.custom.read was added to the endpoint's security scheme oauth2

    • info

      the security scope oauth-access was removed from the endpoint's security scheme oauth2