HubSpot · JSON Structure

Crm Associations Api 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/meta/core/v0/# meta-schema.

Properties

from to 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-result-structure.json",
  "name": "AssociationResult",
  "description": "Result of an association query",
  "type": "object",
  "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",
      "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",
            "items": {
              "$ref": "#/components/schemas/AssociationType"
            },
            "description": "Types of associations between the objects",
            "example": [
              {
                "associationCategory": "HUBSPOT_DEFINED",
                "associationTypeId": 500123,
                "label": "Example Record"
              }
            ]
          }
        },
        "required": [
          "toObjectId",
          "associationTypes"
        ]
      },
      "description": "Associated objects",
      "example": [
        {
          "toObjectId": "500123",
          "associationTypes": [
            {
              "associationCategory": "HUBSPOT_DEFINED",
              "associationTypeId": 500123,
              "label": "Example Record"
            }
          ]
        }
      ]
    },
    "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"
  ]
}