Find Relationship

get

https://apibeta.familysearch.org/platform/tree/persons/{pid}/relationships/{opid}

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.

Path Params

pid

string

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 Search Tree Persons.

opid

string

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 Search Tree Persons.

Query Params

personDetails

string

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

Headers

string

enum

required

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

Allowed:

Responses

200

The read was successful.

204

Upon a successful query with no results.

400

If the query to be processed was unable to be understood by the application.

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here!