Manages associations between custom object types in HubSpot, facilitating complex object relationships.

View Specific Information

Note: Insert and Delete operations may not work for the OAuth Authentication scheme because of insufficient OAuth Apps scopes. Use the Private App Token authentication instead.

SELECT

A query to this table will return all the available associations for each custom object type.

SELECT * FROM CustomObjectAssociations

Note: You cannot reference custom objects by base name. When querying CustomObjectAssociations, if FromObjectTypeId or ToObjectTypeId refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

INSERT

To add a new association between a custom object type and another object type (custom or standard object type), the user must specify at least the ObjectFullyQualifiedName for the source custom object and the Object Type Id-s of the two objects to be associated, ToObjectTypeId and FromObjectTypeId.

INSERT INTO [CustomObjectAssociations] (ObjectFullyQualifiedName, Name, FromObjectTypeId, ToObjectTypeId, Cardinality, InverseCardinality) 
VALUES ('p5692228_MachinesObject', 'machine_to_contactAssoc', '2-1128325', 'contact', 'ONE_TO_MANY', 'ONE_TO_MANY')

Columns

Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier for this specific custom object association.
ObjectFullyQualifiedName [KEY]	String	False		False	Fully qualified name of the object type, combining meta type and unique ID (formatted as _meta_type__uniqueID_).
ObjectTypeId	String	True		False	Unique identifier of the custom object type involved in the association.
ObjectId	String	True		False	Unique ID assigned to the object instance, typically including the portal ID and object name.
ObjectName	String	True		False	Unique name assigned to the schema's object type for identification purposes.
ObjectLabelSingular	String	True		False	Singular display label for the object type, used throughout the CRM interface.
ObjectLabelPlural	String	True		False	Plural display label for the object type, used throughout the CRM interface.
Name	String	False		False	Unique name identifying this specific association between custom objects.
Cardinality	String	False		False	Defines the cardinality of the association, such as one-to-one or one-to-many.
InverseCardinality	String	False		False	Defines the inverse cardinality type, describing how the association appears from the target object's perspective.
FromObjectTypeId	String	False		False	ID of the primary (source) object type from which the association originates.
ToObjectTypeId	String	False		False	ID of the target object type to which the association points.