Match by Genealogies Person Id

Prototype: This resource is currently in a prototype development state. It may or may not be operational and the interface may change prior to release. Feedback is welcome.

Description

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:

title identifier description
FamilySearch Records https://familysearch.org/platform/collections/records (or just "records") The set of FamilySearch records.

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

Operations

GET - Read a set of matches for a Genealogies person.

Produces - Specify a returned data format using the Accept header.
Parameters
Name Type Description
pid path The ID of the genealogies person to match against.
collection query The name of the collection in which to find matches (records or tree). Default=records.
confidence query The minimum level of confidence of the results. The higher the number the higher the confidence desired. Min=1. Max=5.
count query The number of results to provide. Default=5. Min=1. Max=100.
status query The match status(es) by which to filter the results. The default is all statuses are returned.
Status Codes
  • 200  -  Upon a successful read.
  • 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  -  If the request was throttled.

Example Requests

Read Matches by Genealogies Person Id How to get the record matches for a genealogies person id.

Change Language

Feedback

Sending...

Feedback was sent.

Can't send feedback. Retry in 5 seconds.