HubSpot · JSON Structure

Crm Associations Api Association Definition Collection Structure

Collection of association definitions

Type: object Properties: 2 Required: 1

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

AssociationDefinitionCollection 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

{
  "$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-definition-collection-structure.json",
  "name": "AssociationDefinitionCollection",
  "description": "Collection of association definitions",
  "type": "object",
  "properties": {
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "Definition of an association type between two object types",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique identifier for the association definition",
            "example": "500123"
          },
          "fromObjectTypeId": {
            "type": "string",
            "description": "Source object type ID",
            "example": "500123"
          },
          "toObjectTypeId": {
            "type": "string",
            "description": "Target object type ID",
            "example": "500123"
          },
          "name": {
            "type": "string",
            "description": "Name of the association type",
            "example": "Example Record"
          },
          "label": {
            "type": "string",
            "description": "Display label for the association",
            "example": "Example Record"
          },
          "inverseLabel": {
            "type": "string",
            "description": "Label for the inverse association",
            "example": "Example Record"
          },
          "category": {
            "type": "string",
            "enum": [
              "HUBSPOT_DEFINED",
              "USER_DEFINED",
              "INTEGRATOR_DEFINED"
            ],
            "description": "Category of the association definition",
            "example": "HUBSPOT_DEFINED"
          }
        },
        "required": [
          "id",
          "fromObjectTypeId",
          "toObjectTypeId"
        ]
      },
      "description": "Array of association definitions",
      "example": [
        {
          "id": "500123",
          "fromObjectTypeId": "500123",
          "toObjectTypeId": "500123",
          "name": "Example Record",
          "label": "Example Record",
          "inverseLabel": "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"
  ]
}