Ancestry
Path
/platform/tree/ancestry |
|
Production: | https://api.familysearch.org/platform/tree/ancestry |
Beta: | https://apibeta.familysearch.org/platform/tree/ancestry |
Integration (Integration): | https://api-integ.familysearch.org/platform/tree/ancestry |
Description
The Ancestry query is used to query the application for an ascending pedigree rooted at a person and for a specific number of generations. The result of
the query is a list of persons. Each person comes with an ascendancy number
in the display properties for the person. The
ascendancy number
is interpreted as an ahnen number that determines the position of
each person in the pedigree.
Note:
- The
person
parameter is the ID for the person at the root of the pedigree. Theperson
parameter is required. Theancestor number
of the person identified by theperson
parameter will be 1, unless thespouse
parameter is provided. - The presence of the
spouse
parameter indicates that the pedigree of both the person and the person's spouse is requested. When thespouse
parameter is supplied, theascendancy number
of the person and the spouse is either 2 or 3, depending on the role of the person.- If the value of the
spouse
parameter is empty, the application may select a spouse for the person. - Otherwise, the value of the
spouse
parameter is interpreted as the ID of the spouse selected for the pedigree.
- If the value of the
Operations
GET - Read a person and the person's ancestors for the specified number of generations. Produces - Specify a returned data format using the
Accept
header.
Parameters
Status Codes
|
Example Requests
Read Person Ancestry | How to read the ancestry graph for a person. |
Read Person Ancestry and additional person details | How to read the ancestry for a person and return additional person details. |
Read Person Ancestry with Specified Spouse | How to read the ancestry graph for a person with a specified spouse. |
Read Person Ancestry with Specified Spouse and additional person and marriage details | How to read the ancestry graph for a person with a specified spouse and return additional person details and marriage details. |