Ampersand · Schema

AssociationDefinition

Relationship information for a field to another object

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Properties

Name Type Description
associationType string High-level association variety (e.g., 'foreignKey', 'lookup', 'ref')
targetObject string Name of the referenced/parent object
targetField string Name of the referenced field on the target object
cardinality string Association cardinality from the referencing field's perspective
onDelete string Behavior upon foreign object deletion
required boolean If true, a referenced record must exist
reverseLookupFieldName string Optional inverse relationship/property name exposed on the target object
labels object
View JSON Schema on GitHub