v1

latestOpenAPI 3.0.1Apache 2.02026-07-2420454370.2 KB
Matches

Read Person Matches by ID Headers

Determine if there are matches for the given person id.

head/tree/persons/{pid}/matches

Path parameters

pidstring required

The ID of the person whose matches are requested. 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

collection'tree' | 'user_trees' | 'records' | 'cet'

The name of the collection in which to find matches. The possible values are tree, user_trees, or records. Note: 'cet' is deprecated, use 'user_trees' instead.

confidenceinteger

The level of confidence of the results. The higher the number, the higher the confidence desired.

countinteger

The number of results to provide.

statusstring

The match status(es) by which to filter the results. For tree collection matches the default is pending and accepted. For record collection matches the default is pending matches.

treeIdstring

The tree id of the user tree to match against. For use with the user tree collection only. To find user tree IDs, see <a href="/reference/getgroups" target="_blank">Read User's Groups</a>, or <a href="/reference/createtree" target="_blank">Create Tree</a> to create a new user tree.

Response

The read was successful.