Homepage

JoinRecordCollection

Last edit: Oct 13, 2026

How related records are joined: a filtered record and a related record are
related when the value of join_on_property of the first is equal to the value of
foreign_property of the second

type JoinRecordCollection {
  foreign_property: PropertyName!
  join_on_property: PropertyName
  property_type: String
}

Fields

foreign_property (PropertyName)

Property of the related record used for the join; built-in fields such as id,
user_id and external_id are accepted too. An unknown property raises an error

join_on_property (PropertyName)

Property of the filtered record (or user) used for the join; built-in fields
such as id, user_id and external_id are accepted too. Defaults to id

property_type (String)

Type of join_on_property. Set it to array when join_on_property holds a list
of values, to relate every element of the list; detected automatically when omitted

Questions?

We are always happy to help with any questions you may have.

contact us