Guides
Documentation to help FamilySearch development partners get started, understand FamilySearch programming concepts, data, and API usage.

Get Started Guide

Overview

An Introduction to getting started as a FamilySearch development partner.

1. Register with FamilySearch

Get a registered developer account with FamilySearch.

2. Register for an App Key

Register you app with FamilySearch to receive an app key.

3. Set Up Your Programming Environment

Establish the programming environment of your choice so you can begin writing code.

4. Code Your App

Write the code for your app using FamilySearch tools.

5. Certify Your App

Certify your app with FamilySearch and add it to the FamilySearch App Gallery.

Web Integration Guide

A guide for integrating Web applications with the FamilySearch API.

Mobile/Desktop Integration Guide

A guide for integrating mobile and desktop applications with the FamilySearch API.

API Concepts Guide

API Evolution

Learn how the API evolves over time and how developers can write software that adapts to the changes.

Caching

The APIs are designed to be cacheable. Learn what that means for you.

Client Credentials Authentication

To obtain a client secret, use private key encryption or signing.

Dates

Explanation of the date format and the difference between formal and normalized values.

Family Tree Collaboration

Learn about the FamilySearch Family Tree Model and how to work collaboratively with it.

HTTP

HTTP standards that the FamilySearch API uses.

Hypermedia

How to leverage hypermedia to discover available resources and options to your application.

Internationalization

Internationalization support in the FamilySearch API.

Merging

The effects and nuances of merging.

Migration from Family Tree v2

Mapping of old API resources to the new resources.

Names

Name types, name forms, name parts, and how preferred and alternate names behave.

Persistent Identifiers

About the use of persistent identifiers, such as the Artifact Resource Key (ARK), in the API.

Private Spaces

Explanation of the implementation and migration to private spaces.

Redirecting

Guide for Redirecting to FamilySearch Pages.

Synchronization

Guide for how to keep data in sync with FamilySearch data.

Throttling

Requests to the API are rate-limited on a per-user basis.

Data Guide

The Family Tree Data Model

Description of the FamilySearch Family Tree data model.

GEDCOM X

Learn what GEDCOM X is.

Data Access Paths

A general description of how to access FamilySearch data.

API Resources Guide

Authentication

Description of multiple authentication methods and behavior of session tokens.

Authorities

Documentation for our authorities API which includes Place, Name, and Date authorities.

Change History

Explanation of the data returned by change history resources.

Collections

Description of the Collections resource.

Genealogies

How to access the FamilySearch Genealogies database using the Genealogies API.

Memories

Upload, read, delete, and attach memories such as photos, stories, or documents.

Ordinances

Temple ordinance reservation programming guidance.

Pedigree

How to build out a pedigree for a person using the API.

Persons in Family Tree

An explanation of the intricacies and pitfalls of creating and updating people.

Places

Read and search for places as described by the FamilySearch place authority.

Search and Match

Guidelines for FamilySearch Searching and Matching.

Sources

Learn about how to use and work with sources.

User

Information about the current user and other users.

Reference Guide

Facts

A table of facts and supported fact types.

Glossary

A glossary of terms often used in the FamilySearch API developer documentation.

HTTP Status Codes

The meaning of different HTTP status codes returned by the API.

Webinars

Webinars

Training and update webinars for partners.

Destination Pages

Create Source

Allow partners to attach sources to Family Tree