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.
Filter and Facet Parameters
This endpoint supports dynamic f.* (filter) and c.* (facet) parameters controlled by the underlying search service. Due to the large number of possible combinations and their dynamic nature, only commonly-used examples are shown below.
⚠️ Parameter Format: Filter and facet parameters follow the pattern:
- Filters:
f.[parameter]=[value](e.g.,f.birthPlace0=3,Canada) - Facets:
c.[parameter]=on(e.g.,c.sex=on)
Multiple Facets: You can enable multiple facet parameters simultaneously (e.g., c.sex=on&c.birthYear0=on) to see distribution across different dimensions.
Hierarchical Parameters: For hierarchical data like places (birthYear0, birthYear1, birthYear2), you can jump directly to any level without filtering intermediate levels. For example, you can use c.birthPlace1=on without setting f.birthPlace0 to see all state-level distributions.
For the list of common parameters and detailed faceting workflows, see the Search/Faceting/Filter Guide.
For information on Family Tree Search specifically, see the Family Tree Search Guide.
You can explore this endpoint interactively by setting sample query parameters below.
"Try It!" LimitationsThe 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 and the examplef./c.parameters shown below, it does not support all possible filter and facet combinations.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.
To discover available parameters dynamically, use faceting: enable
c.[parameter]=onin your request, and the response will include valid filter values you can use.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
The read was successful. See Person Schema (JSON)
Upon a successful search with no results.
The request was unable to be understood by the application. See response warning headers for details.
The request was throttled.