HubSpot · Schema
AssociationLabelCollection
Collection of association labels
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales
Properties
| Name | Type | Description |
|---|---|---|
| results | array | Array of association labels |
| paging | object | Pagination information |
JSON Schema
{
"type": "object",
"description": "Collection of association labels",
"properties": {
"results": {
"type": "array",
"description": "Array of association labels",
"example": [
{
"typeId": 500123,
"label": "Example Record",
"category": "HUBSPOT_DEFINED"
}
],
"items": {
"type": "object",
"description": "A label that can be applied to associations",
"properties": {
"typeId": {
"type": "integer",
"description": "Numeric identifier for the label type",
"example": 500123
},
"label": {
"type": "string",
"description": "Display text for the label",
"example": "Example Record"
},
"category": {
"type": "string",
"description": "Category of the label",
"example": "HUBSPOT_DEFINED",
"enum": [
"HUBSPOT_DEFINED",
"USER_DEFINED",
"INTEGRATOR_DEFINED"
]
}
},
"required": [
"typeId",
"label",
"category"
]
}
},
"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": [
"results"
],
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "AssociationLabelCollection"
}