v1

latestOpenAPI 3.0.1Apache 2.02026-07-2420454370.2 KB
Relationships

Find Relationship

The Relationship Finder resource is used to find how two persons in the tree are related. For finding how the currently logged in user is related to a person in the tree, pass in "CURRENT" for the first person Id. The later option requires an authenticated session. To determine which of the persons returned is the common ancestor the fs:displayProperties element will contain a "role" field that contains "commonAncestor" as a value.

get/tree/persons/{pid}/relationships/{opid}

Path parameters

pidstring required

The id of the person to start the relationship search from. Can be a person from the main FamilySearch tree or from a user tree. To find an example person ID, see <a href="/reference/searchtreepersons" target="_blank">Search Tree Persons</a>.

opidstring required

The id of the person to end the relationship search at. Can be a person from the main FamilySearch tree or from a user tree. To find an example person ID, see <a href="/reference/searchtreepersons" target="_blank">Search Tree Persons</a>.

Query parameters

personDetailsstring

When the query parameter is set to true, the additional person details will be returned for each person.

Headers

Accept'application/x-fs-v1+json' | 'application/x-gedcomx-v1+json' | 'application/json' required

Specifies the media type(s) that the client is willing to accept in the response.

Response

The read was successful. See <a href="https://developers.familysearch.org/main/docs/json-schema#person" target="_blank">Person Schema (JSON)</a>