Sign in

v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Basic

Retrieve the schema of a specified custom object.

Retrieve details of a custom object schema, including its properties and associations, using the object type ID or fully qualified name.

get/crm-object-schemas/2026-03/schemas/{objectType}

Path parameters

objectTypestring required

Query parameters

includeAssociationDefinitionsboolean
includeAuditMetadataboolean
includePropertyDefinitionsboolean

Response

successful operation

allowsSensitivePropertiesboolean required
archivedboolean required
createdAtstring date-time

When the object schema was created.

createdByUserIdinteger
descriptionstring
fullyQualifiedNamestring required

An assigned unique ID for the object, including portal ID and object name.

idstring required

A unique ID for this schema's object type. Will be defined as {meta-type}-{unique ID}.

namestring required

A unique name for the schema's object type.

objectTypeIdstring required
primaryDisplayPropertystring

The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.

requiredPropertiesstring[] required

The names of properties that should be required when creating an object of this type.

searchablePropertiesstring[] required

Names of properties that will be indexed for this object type in by HubSpot's product search.

secondaryDisplayPropertiesstring[] required

The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.

updatedAtstring date-time

When the object schema was last updated.

updatedByUserIdinteger