get_relationship
Determine how two people in a Gramps family tree are related, returning the relationship and generation distance to their common ancestor, or confirm no link within search depth.
Instructions
Work out how two people in the tree are related.
Returns the relationship in words plus the generation distance from each
person to their common ancestor. related is false when no common
ancestor was found within the search depth — which is a finding in itself
if you expected one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| depth | No | Generations to search. Server default if omitted. | |
| person1 | Yes | Handle or gramps_id of the first person. | |
| person2 | Yes | Handle or gramps_id of the second person. | |
| all_paths | No | Report every relationship path, not just the closest. Use this when two people may be related more than one way. |