Read Person Matches by ID

get

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

Certification Required

The Match by Tree Person Id endpoint defines the set of matches in the system for a person in the Family Tree.

The scope of the match results can be limited to a specific collection using the collection query parameter.

Use of the collection query parameter in a production environment is restricted to applications that have been certified. Applications requesting record matches must be certified. See Record Hinting Certification.

Currently, only the following collections support match results:

title	identifier	description
FamilySearch Tree	`https://familysearch.org/platform/collections/tree` (or just "tree")	The set of matches (possible duplicates) in the FamilySearch tree.
FamilySearch Records	`https://familysearch.org/platform/collections/records` (or just "records")	The set of matches in the FamilySearch records.
FamilySearch User Trees	`https://familysearch.org/platform/collections/cet` (or just "cet")	The set of matches in the FamilySearch user trees.

If no collection is specified, the request will be interpreted as matches in the FamilySearch tree (possible duplicates) Family Tree.

Each match has a "status" that indicates it to be in one of the following states:

name	identifier	description
Pending	`http://familysearch.org/v1/Pending`	The match has neither been accepted nor rejected.
Accepted	`http://familysearch.org/v1/Accepted`	The match has been accepted as valid.
Rejected	`http://familysearch.org/v1/Rejected`	The match has been rejected as invalid.

Match results can be filtered using the status query parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

pid

string

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

Query Params

collection

string

enum

Defaults to tree

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.

Allowed:

confidence

int64

1 to 5

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

count

int64

1 to 100

Defaults to 5

The number of results to provide.

status

string

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.

treeId

string

The tree id of the user tree to match against. For use with the user tree collection only. To find user tree IDs, see Read User's Groups, or Create Tree to create a new user tree.

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. See Person Schema (JSON)

204

Upon a successful read with no matches.

301

If the person has been merged.

404

If the person was not found.

410

If the person has been deleted.

429

The request was throttled.