HubSpot · Schema
AssociationResult
Result of an association query
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales
Properties
| Name | Type | Description |
|---|---|---|
| from | object | Reference to a CRM object by ID |
| to | array | Associated objects |
| paging | object | Pagination information |
JSON Schema
{
"type": "object",
"description": "Result of an association query",
"properties": {
"from": {
"type": "object",
"description": "Reference to a CRM object by ID",
"properties": {
"id": {
"type": "string",
"description": "ID of the object",
"example": "500123"
}
},
"required": [
"id"
]
},
"to": {
"type": "array",
"description": "Associated objects",
"example": [
{
"toObjectId": "500123",
"associationTypes": [
{
"associationCategory": "HUBSPOT_DEFINED",
"associationTypeId": 500123,
"label": "Example Record"
}
]
}
],
"items": {
"type": "object",
"description": "Represents an association between two CRM objects",
"properties": {
"toObjectId": {
"type": "string",
"description": "ID of the target object",
"example": "500123"
},
"associationTypes": {
"type": "array",
"description": "Types of associations between the objects",
"example": [
{
"associationCategory": "HUBSPOT_DEFINED",
"associationTypeId": 500123,
"label": "Example Record"
}
],
"items": {
"type": "object",
"description": "Defines the type of association",
"properties": {
"associationCategory": {
"type": "string",
"description": "Category of the association type",
"example": "HUBSPOT_DEFINED",
"enum": [
"HUBSPOT_DEFINED",
"USER_DEFINED",
"INTEGRATOR_DEFINED"
]
},
"associationTypeId": {
"type": "integer",
"description": "Numeric identifier for the association type",
"example": 500123
},
"label": {
"type": "string",
"description": "Human-readable label for the association",
"example": "Example Record"
}
},
"required": [
"associationCategory",
"associationTypeId"
]
}
}
},
"required": [
"toObjectId",
"associationTypes"
]
}
},
"paging": {
"type": "object",
"description": "Pagination information",
"properties": {
"next": {
"type": "object",
"description": "Pagination cursor for next page",
"properties": {
"after": {
"type": "string",
"description": "Cursor token for the next page",
"example": "example-value"
},
"link": {
"type": "string",
"description": "Link to the next page",
"example": "https://app.hubspot.com/contacts/12345"
}
}
}
}
}
},
"required": [
"from",
"to"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "AssociationResult"
}