Welcome to the FamilySearch API Reference! This section is dedicated specifically to the details of the API endpoints, operations, parameters, JSON schemas, and how to use the built-in tools for exploring and testing them.
Navigating the API Reference
The API Reference includes:
- A full list of publicly available endpoints grouped by function.
- Supported HTTP operations such as GET, POST, PUT, HEAD, DELETE.
- Descriptions for path, query, and body parameters.
- The JSON schema used by the API.
Use the sidebar navigation or site search to find what you need quickly.
Old API Reference
The previous API Reference will remain accessible through September 2025, but it is no longer maintained. Deprecated pages will eventually redirect here.
Using the "Try It" Functionality
Each endpoint includes a "Try It" panel that lets you make live requests to the Beta environment.
Steps to Use:
- Fill in required fields and parameters. Most read endpoints offer example IDs.
- Paste your OAuth 2.0 access token into the Bearer field under “Credentials”.
- Click "Try It" to send the request and view the live response.
Getting an Access Token
If your application already has OAuth 2.0 integration, you are encouraged to use your application's Beta environment access token. This ensures your test calls accurately reflect real application behavior.
If you have not yet completed your OAuth 2.0 integration, you can obtain an access token for use with the Beta environment from this page.
How to Get Example IDs
Many of the endpoints require identifiers like a person ID (pid). Wherever possible, "read" operations will have an example ID you can use for reading sample data. Please do not modify or delete sample data. This ensures consistent behavior for all developers using the “Try It” feature.
To use the example IDs, click on the parameter field, and a drop-down will appear with an option to select an example ID.
Finding Example Requests
The Example Requests section of the developer Guides provides a collection of requests for common use cases. You can also use tools like Bruno or Postman to create, edit, and execute requests outside the API Explorer.
JSON Schema Reference
The data used in requests and responses conform to structured JSON schemas. View the FamilySearch API JSON Schema for full type definitions. The schema helps to clarify object structures, required fields, and allowable values.
Popular Endpoints
Some frequently accessed endpoints include:
- Read Person: View details about a specific person details.
- Read Current User Tree Person: Retrieve the details for the person representing the currently authenticated user.
- Create Person: Add a new person to a tree.
- Places Search: Look up geographical locations.