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.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier for the CRM object type whose schema is being retrieved.
Query Parameters
A boolean indicating whether to include association definitions in the response. Defaults to true.
A boolean indicating whether to include audit metadata in the response. Defaults to true.
A boolean indicating whether to include property definitions in the response. Defaults to true.
Response
successful operation
A boolean indicating whether the object schema allows sensitive properties.
A boolean indicating whether the object schema is archived.
Associations defined for a given object type.
An assigned unique ID for the object, including portal ID and object name.
A unique ID for this schema's object type. Will be defined as {meta-type}-{unique ID}.
A unique name for the schema's object type.
A string representing the type ID of the object.
Properties defined for this object type.
The names of properties that should be required when creating an object of this type.
Names of properties that will be indexed for this object type in by HubSpot's product search.
The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
When the object schema was created.
An integer representing the ID of the user who created the object schema.
A string providing a description of the object schema.
The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
When the object schema was last updated.
An integer representing the ID of the user who last updated the object schema.