HUhubspot
Basic

Retrieve all custom object schemas.

Changed on

Retrieve all custom object schemas, with options to include property definitions, association definitions, and audit metadata.

get/crm-object-schemas/2026-09/schemas

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm-object-schemas/2026-09/schemas
  • 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

Query parameters

archivedboolean

Whether to return only results that have been archived.

includeAssociationDefinitionsboolean

Whether to include association definitions in the response. Defaults to true.

includeAuditMetadataboolean

Whether to include audit metadata in the response. Defaults to true.

includePropertyDefinitionsboolean

Whether to include property definitions in the response. Defaults to true.

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 crm.objects.custom.read was removed from the endpoint's security scheme oauth2