Read Person Matches by ID Headers

head

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

Determine if there are matches for the given person id.

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.

Responses

200

The read was successful.

204

Upon a successful query with no results.

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.

Language

Credentials

Bearer

Loading…

Response

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