ObjectAssociationTypesByObjectAndToObjectTypeId |
Retrieve all associations by object typeRetrieve all associations between a specific record and an object type. Limit 500 per call.
Catalog: Associations
Schema: Basic
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function ObjectAssociationTypesByObjectAndToObjectTypeId. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
after |
string |
☐ |
|
The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. |
objectId |
string |
☑ |
|
|
objectType |
string |
☑ |
|
|
toObjectType |
string |
☑ |
|
|
Columns of Table Function
The columns of the table function ObjectAssociationTypesByObjectAndToObjectTypeId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
category |
string |
Category |
☐ |
The category of the association, such as HUBSPOT_DEFINED, USER_DEFINED, or INTEGRATOR_DEFINED. |
label |
string |
Label |
☐ |
A label describing the association between two objects. |
toObjectId |
string |
|
☐ |
The unique identifier for the target object in the association. |
typeId |
int32 |
Type ID |
☐ |
The unique identifier for the type of association. |
HubSpot API Data Model