AssociationDefinition

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-schema/crm-associations-api-association-definition-schema.json",
  "title": "AssociationDefinition",
  "description": "Definition of an association type between two object types",
  "type": "object",
  "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"
  ]
}