HubSpot · JSON Structure

Hubspot Crm Associations Association Result Structure

Result of an association query

Type: object Properties: 3 Required: 2

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

AssociationResult is a JSON Structure definition published by HubSpot, describing 3 properties, of which 2 are required. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

from to paging

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

{
  "type": "object",
  "description": "Result of an association query",
  "name": "AssociationResult",
  "properties": {
    "from": {
      "type": "object",
      "description": "Reference to a CRM object by ID",
      "properties": {
        "id": {
          "type": "string",
          "description": "ID of the object"
        }
      },
      "required": [
        "id"
      ]
    },
    "to": {
      "type": "array",
      "description": "Associated objects",
      "items": {
        "type": "object",
        "description": "Represents an association between two CRM objects",
        "properties": {
          "toObjectId": {
            "type": "string",
            "description": "ID of the target object"
          },
          "associationTypes": {
            "type": "array",
            "description": "Types of associations between the objects",
            "items": {
              "type": "object",
              "description": "Defines the type of association",
              "properties": {
                "associationCategory": {
                  "type": "string",
                  "description": "Category of the association type",
                  "enum": [
                    "HUBSPOT_DEFINED",
                    "USER_DEFINED",
                    "INTEGRATOR_DEFINED"
                  ]
                },
                "associationTypeId": {
                  "type": "integer",
                  "description": "Numeric identifier for the association type"
                },
                "label": {
                  "type": "string",
                  "description": "Human-readable label for the association"
                }
              },
              "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"
            },
            "link": {
              "type": "string",
              "description": "Link to the next page"
            }
          }
        }
      }
    }
  },
  "required": [
    "from",
    "to"
  ],
  "$schema": "https://json-structure.org/draft/2020-12/schema"
}