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-03/schemas

Request

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

Query parameters

archivedboolean

Whether to return only results that have been archived.

includeAssociationDefinitionsboolean
includeAuditMetadataboolean
includePropertyDefinitionsboolean

Response

successful operation

Changes

    • info

      api operation id get-/crm-object-schemas/2026-03/schemas_getAll removed and replaced with get-/crm-object-schemas/2026-03/schemas

    • info

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

    • info

      the security scope crm.objects.custom.highly_sensitive.read.v2 was removed from the endpoint's security scheme private_apps

    • info

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

    • info

      the security scope crm.objects.custom.highly_sensitive.read.v2 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.