HubSpot · JSON Structure

Crm Associations Api Association Label Collection Structure

Collection of association labels

Type: object Properties: 2 Required: 1
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

AssociationLabelCollection is a JSON Structure definition published by HubSpot, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

results paging

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/crm-associations-api-association-label-collection-structure.json",
  "name": "AssociationLabelCollection",
  "description": "Collection of association labels",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "A label that can be applied to associations",
        "properties": {
          "typeId": {
            "type": "int32",
            "description": "Numeric identifier for the label type",
            "example": 500123
          },
          "label": {
            "type": "string",
            "description": "Display text for the label",
            "example": "Example Record"
          },
          "category": {
            "type": "string",
            "enum": [
              "HUBSPOT_DEFINED",
              "USER_DEFINED",
              "INTEGRATOR_DEFINED"
            ],
            "description": "Category of the label",
            "example": "HUBSPOT_DEFINED"
          }
        },
        "required": [
          "typeId",
          "label",
          "category"
        ]
      },
      "description": "Array of association labels",
      "example": [
        {
          "typeId": 500123,
          "label": "Example Record",
          "category": "HUBSPOT_DEFINED"
        }
      ]
    },
    "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"
  ]
}