Read Genealogies Person Matches

The Person Matches by Genealogies Person Id resource defines the set of matches in the system for a person in the user-submitted genealogies.

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

Use of the this resource in a production environment is restricted to applications that have been certified. Hinting applications must be certified. See Record Hinting Certification.

Currently, only the following collections support match results:

titleidentifierdescription
FamilySearch Recordshttps://familysearch.org/platform/collections/records (or just "records")The set of FamilySearch records.

If no collection is specified, the "records" collection will be assumed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the genealogies person (from user-submitted genealogies) to match against. To find genealogies person IDs, see Read Genealogies Persons.

Query Params
string
Defaults to records

The name of the collection in which to find matches (records or tree).

string
1 to 5

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

string
1 to 100
Defaults to 5

The number of results to provide.

string

The match status(es) by which to filter the results. The default is all statuses are returned.

Responses
200

The read was successful. See Person Schema (JSON)

204

Upon a successful query with no results.

301

If the genealogies person has been merged.

404

If the genealogies person was not found.

410

If the genealogies person has been deleted.

429

The request was throttled.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here!