Getting Started Developing with FamilySearch

The FamilySearch API is a RESTful Web service that can be used to enable your apps to read and write data in various FamilySearch resources. Follow the steps in this guide to get started on the FamilySearch platform.

Important Note: Before beginning any development please click and read the document App Approval Considerations.

Create a Developer Account

See Developer Support.

Your App Key

A unique app key is assigned to your app and is shown on the Application Details page of each app. You must use this app key to access the FamilySearch API calls you make. Your app key is automatically enabled to access Beta and Production access has additional requirements. See Developer Support for help.

• Beta
  This is an old snapshot of production data. It’s used for testing in a production-like environment. This system is not always current.
• Production
  After you are accepted in the Compatible Solution Program and completed the app compatibility process, your app key will be enabled to access the production FamilySearch data.

Get An Access Token Using OAuth 2

The first step your app must do is to authenticate with FamilySearch by obtaining an access token. This access token is required for every other FamilySearch resource request. Read the Authentication guide to become familiar with the FamilySearch authentication process.

Develop Your App

The next step is to proceed with developing your code. This website includes the following resources to help you with your coding efforts.

• Tools & SDKs for various programming languages.
• API Reference specifications with links to sample code. Data Formats specifications.
• Compatibility Checklist that provides the requirements for each feature set that can be considered compatible.

Take a look at the API Reference, find the data you need, and follow the example in the example request. For example,  Read Current User and follow the Read Current User Example request.

Tools & SDKs

You may want to leverage SDKs made available for application developers. SDKs are available for Java, PHP, and JavaScript. For more information, see the Tools & SDKs section of the Developer Center.