Search Tree Persons

get

https://apibeta.familysearch.org/platform/tree/search

This operation enables you to search tree persons using a variety of query parameters such as name, event dates and places, sex, and more. This operation returns person summaries that match the search criteria.

For a detailed explanation of all supported query parameters, including formatting examples, filtering tips, and usage guidelines, see the Family Tree Search guide.

You can explore this endpoint interactively setting sample query parameters below.

"Try It!" Limitations

The built-in API explorer has limited support for this operation due to the complexity of the query parameter structure. While you can run simple queries using q. parameters, it does not support setting f. (filter) or c. (facet) parameters effectively.

For full testing capabilities, we recommend using an external API client tool such as Bruno or Postman , which offer more control over request construction and parameter encoding.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

q.givenName

string

The given name of the person being searched.

q.surname

string

The family name of the person being searched.

q.sex

string

The sex of the person being searched. Valid values are documented in Gedcomx Known Gender Types. 'http://gedcomx.org/' should not be included in the value. 'Male', 'Female', etc. is all that is required.

q.birthLikeDate

string

The birth like Gedcomx date of the person being searched.

q.birthLikePlace

string

The birth like place of the person being searched.

q.deathLikeDate

string

The death like Gedcomx date of the person being searched.

q.deathLikePlace

string

The death like place of the person being searched.

q.marriageLikeDate

string

The marriage like Gedcomx date of the person being searched.

q.marriageLikePlace

string

The marriage like place of the person being searched.

q.residenceDate

string

A Gedcomx date of residence of the person being searched.

q.residencePlace

string

A place of residence of the person being searched.

q.fatherGivenName

string

The given name of a father of the person being searched.

q.fatherSurname

string

The family name of a father of the person being searched.

q.fatherBirthLikePlace

string

The birth like place of a father of the person being searched.

q.motherGivenName

string

The given name of a mother of the person being searched.

q.motherSurname

string

The family name of a mother of the person being searched.

q.motherBirthLikePlace

string

The birth like place of a mother of the person being searched.

q.parentGivenName

string

The given name of a parent of the person being searched. If the sex is known to be 'Male' or 'Female', use 'mother' or 'father' rather than 'parent'.

q.parentSurname

string

The family name of a parent of the person being searched. If the sex is known to be 'Male' or 'Female', use 'mother' or 'father' rather than 'parent'

q.parentBirthLikePlace

string

The birth like place of a parent of the person being searched.

q.spouseGivenName

string

The given name of the spouse of the person being searched.

q.spouseSurname

string

The family name of the spouse of the person being searched.

string

The search filter parameters.

string

The search facet parameters.

offset

int64

The 0 based index of the first result to be returned. Default = 0. 0 <= offset <= 4999

count

int64

The maximum number of search results to return. Default = 20. 1 <= count <= 100.

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 search with no results.

400

The request was unable to be understood by the application. See response warning headers for details.

429

The request was throttled.