Jump to Content
FamilySearch APIGuidesAPI ReferenceChangelogHelp
GuidesChangelogDiscussions
v1.1

GuidesAPI ReferenceChangelogHelpLog InFamilySearch API
Guides
Log In
v1.1GuidesChangelogDiscussions

FamilySearch API Overview

  • Getting Started
  • App Approval Considerations
  • Authentication
    • OAuth 2.0 for Native Apps
    • Token Refresh
    • API Key Management
    • Client Credentials Authentication
  • Compatibility Review Process
    • Compatibility Checklist
  • Tools & SDKs
  • Support

API Concepts

  • API Evolution
  • Caching
  • HTTP
  • HTTP Status Codes
  • Internationalization
  • Linking to FamilySearch Pages
  • Persistent Identifiers
  • Keeping in Sync with FamilySearch Data
  • Throttling
  • Glossary

Family Tree

  • The Family Tree Data Model
    • GEDCOM X
    • Persons
    • Names
    • Facts
    • Dates
  • Search and Match
  • Family Tree Search
  • Family Tree Matching and Hinting
  • Merging
  • Change History
  • Pedigree
  • Contributing to the FamilySearch Family Tree
  • Private Spaces and Data Access Control
  • Contributing Sources

CET

  • [CET] API Guide
    • Comparison of Family Tree and [CET]
    • FamilySearch Tree System
    • [CET] Access Model
    • [CET] Privacy Settings
    • Current Tree Selection
  • Uploading a Tree to [CET]
  • Downloading a [CET] Tree
  • Syncing Family Trees
  • Integrating Hints
  • Deleting a [CET] Tree
  • CET Compatibility

Documentation

  • Authorities
  • Genealogies
  • Memories
  • Places
  • User
  • Source Create Page

Example API Requests

  • Example Requests
  • Authentication
    • Initiate Authorization
    • Obtain Access Token
    • Delete Access Token
    • Initiate Authorization (Invalid Parameter)
    • Obtain Access Token (Bad Parameters)
    • Obtain Access Token without Authenticating
    • Obtain Access Token with Username and Password
  • Change History
    • Read Child-and-Parents Relationship Change History
    • Read Couple Relationship Change History
    • Read Person Change History
    • Read Person Change History First Ten Entries
    • Restore Change Action
  • Collections
    • Read Controlled Vocabulary
    • Read Date Authority
    • Read Discussions Collection
    • Read FamilySearch Collections
    • Read Family Tree Collection
    • Read Genealogies Collection
    • Read Memories Collection
    • Read Place Authority
    • Read Root Collection
    • Read User-Defined Sources Collection
    • Read FamilySearch Historical Records Archive
  • Discussions
    • Create Comment
    • Create Discussion
    • Delete Comment
    • Read Comments
    • Read Discussion
    • Update Comment
    • Update Discussion
  • Genealogies
    • Create Genealogies Person
    • Create Genealogies Relationship Conclusion
    • Create Genealogies Source Description
    • Create Genealogies Tree
    • Delete Genealogies Conclusion
    • Delete Genealogies Person
    • Delete Genealogies Person With Preconditions
    • Delete Genealogies Relationship
    • Delete Genealogies Source Description
    • Delete Genealogies Tree
    • Head Genealogies Person
    • Read Genealogies Deleted Person
    • Read Genealogies Merged Person
    • Read Genealogies Not Modified Person
    • Read Genealogies Person
    • Read Genealogies Source Description
    • Read Genealogies Tree
    • Read Genealogies Trees
    • Read Matches by Genealogies Person Id
    • Read Page of the Genealogies Persons in a Tree
    • Restore Genealogies Person
    • Update Genealogies Person
    • Update Genealogies Source Description
    • Update Genealogies Tree
    • Merge Genealogies Person
    • Update Genealogies Media Item
    • Read Genealogies Note
    • Read Genealogies Person Change History
    • Delete Genealogies Media Item
    • Create Genealogies Media Item
    • Read Genealogies Persons By External Ids
    • Read Genealogies Agent
    • Read Genealogies Person Change History First Ten Entries
    • Read Genealogies Media Item
  • Memories
    • Create Memories Comment
    • Create Memory Persona
    • Delete Memories Comment
    • Delete Memory
    • Delete Memory Artifact Coverage
    • Delete Memory Persona
    • Read Memories Comments
    • Read Memories for a User
    • Read Memory
    • Read Memory Persona
    • Read Memory Personas
    • Update Memory Description
    • Update Memory Persona
    • Update Story
    • Update Story Via Multipart Form Data
    • Upload Image as a Document
    • Upload Multiple Photo Memories
    • Upload PDF Document
    • Upload Photo
    • Upload Photo Via Multipart Form Data
    • Upload Story
    • Upload Story Memories
  • Names
    • Parse Segments
    • Read Name Script
    • Read Name Segments
  • Parents and Children
    • Create Child and Parents Relationship
    • Create Child-and-Parents Relationship Conclusion
    • Create Child-and-Parents Relationship Note
    • Create Child-and-Parents Relationship Source Reference
    • Delete Child-and-Parents Relationship
    • Delete Child-and-Parents Relationship Source Reference
    • Read Child-and-Parents Relationship
    • Read Child-and-Parents Relationship Notes
    • Update Child-and-Parents Relationship Conclusion
    • Read Child-and-Parents Relationship Note
    • Delete Child-and-Parents Relationship Parent
    • Update Child-and-Parents Relationship Note
    • Read Child-and-Parents Relationship Sources
    • Update Child-and-Parents Relationship
    • Read Child-and-Parents Relationship Source References
    • Delete Child-and-Parents Relationship Conclusion
    • Set Child-and-Parents Relationship Parents Ordering
    • Delete Child-and-Parents Relationship Note
    • Restore Child-and-Parents Relationship
  • Pedigree
    • Read Person Descendancy and additional person and marriage details
    • Read Person Ancestry and additional person details
    • Read Person Ancestry with Specified Spouse
    • Read Person Ancestry with Specified Spouse and additional person and marriage details
    • Read Person Ancestry
    • Read Person Descendancy
  • Person
    • Read Children of a Person
    • Update Person Portraits
    • Restore Person
    • Read Person Portraits
    • Read Persons
    • Create Person
    • Delete Preferred Parent Relationship
    • Create Discussion Reference
    • Delete Note
    • Update Preferred Parent Relationship
    • Read Person
    • Create Person Conclusion
    • Create Person Life Sketch
    • Delete Person Conclusion
    • Delete Person Memory Reference
    • Read Person Merge Constraint (Can Merge Any Order)
    • Update Person Conclusion
    • Read Preferred Spouse Relationship
    • Merge Person
    • Read Person Portrait
    • Update Person Source Reference
    • Read Merged Person
    • Delete Person Portrait Selection
    • Read Person Memories By Type
    • Update Note
    • Read Person Portrait With Default
    • Update Person Life Sketch
    • Read Spouses of a Person
    • Read Preferred Parent Relationship
    • Create Person Source Reference
    • Upload Photo for Person
    • Read Families of a Person
    • Read Person Merge Analysis
    • Read Parents of a Person
    • Delete Person Source Reference
    • Create Note
    • Update Person With Preconditions
    • Read Deleted Person
    • Read Person Merge Constraint (Can Merge Other Order Only)
    • Delete Person With Preconditions
    • Read Notes
    • Read Person Sources
    • Update Person Custom Non-Event Fact
    • Read Spouses of a Person but no Relationship
    • Delete Preferred Spouse Relationship
    • Delete Discussion Reference
    • Head Person
    • Read Not Modified Person
    • Read Not Found Person
    • Update Preferred Spouse Relationship
    • Read Note
    • Read Person Memories
    • Read Person Not-A-Match Declarations
    • Delete Person
  • Places
    • Search For Places Under a Jurisdiction
    • Read Place Descriptions Group
    • Read Place Type Groups
    • Read Place Descriptions
    • Read Place Types
    • Read Place Type Group
    • Search For Places Directly Under a Jurisdiction
    • Read Place Description
    • Read Place Description with Related
    • Read Place Description Attributes
    • Search For Places
    • Read Place Type
    • Read Place Description Children
  • Search and Match
    • Read Person Matches using Gedcomx
    • Read Person Matches using query
    • Update Match Status by Tree Person Id for Record Matches
    • Read Matches by Tree Person Id
    • Search for tree persons with wildcard characters
    • Delete Person Not-a-Match Declarations
    • Read Matches by Tree Person Id for All Match Status Types
    • Search for tree persons - first page
    • Search for tree persons with cardinality and modifier.
    • Search for tree persons - next page
    • Read Person Possible Duplicates
    • Read Matches by Tree Person Id with Higher Confidence
    • Update Person Not-a-Match Declarations
  • Sources
    • Move Sources to a Folder
    • Read Source Folder
    • Read User Source Descriptions
    • Update Source Description
    • Create Source Folder
    • Create Source Description
    • Delete Source Descriptions from a Folder
    • Read User Source Folders
    • Read Source Description
    • Update Source Folder
    • Read a Page of the Sources in a Folder
    • Read Source References
    • Delete Source Folder
    • Delete Source Description
    • Create User-Uploaded Source
  • Spouses
    • Update Couple Relationship Conclusion
    • Read Couple Relationship (Conditional)
    • Delete Couple Relationship Source Reference
    • Read Couple Relationship Source References
    • Delete Couple Relationship Note
    • Update Illegal Couple Relationship
    • Update Persons of a Couple Relationship
    • Read Couple Relationship
    • Read Non-Existent Couple Relationship
    • Update Couple Relationship Note
    • Restore Couple Relationship
    • Read Couple Relationship Notes
    • Set Couple Relationship Spouses Ordering
    • Update Couple Relationship Notes
    • Read Couple Relationship Note
    • Create Couple Relationship
    • Create Couple Relationship Source Reference
    • Read Couple Relationship Sources
    • Create Couple Relationship Note
    • Create Couple Relationship Conclusion
    • Head Couple Relationship
    • Delete Couple Relationship Conclusion
    • Delete Couple Relationship
  • User
    • Read User
    • Read Current User
    • Read Current Tree Person
    • Read Current Tree Person Expecting 200 Response
  • Utilities
    • Read Person With Multiple Pending Modifications Activated
    • Read Person With Pending Modification Activated
  • Vocabularies
    • Read Vocabulary List
    • Read Vocabulary Term
    • Read Vocabulary Term, Alternate Language

Support

Suggest Edits

FamilySearch API Support

For technical questions regarding the FamilySearch API, please use the Q&A Discussions. If you need help with your keys or configuration, please email us at [email protected].

General FamilySearch Support

For broad questions related to the FamilySearch website and family history research, please contact FamilySearch Support.

Updated 2 months ago


  • Table of Contents
    • FamilySearch API Support
    • General FamilySearch Support

What We Offer

Family Tree
Genealogy Records
Family Photo Sharing
Family Activities
Learning Resources
Research Guidance
DNA Education
Surname Meanings

Ways to Contribute

Get Involved
Indexing
Volunteer
Donate

Guidance and Learning

Getting Started
RootsTech Conference
What's New
Learning Center
Genealogy Research Wiki
YouTube Channel
Free Virtual Consultations
Blog
Helpful Resources

Get Help

User Community
Help Center
Contact Us
Your Account
Suggest an Idea

Genealogy Resources

Obituaries
Cemeteries
FamilySearch Catalog
Ancestor Search
Genealogy Search
Place Names
Guided Research
Digital Books
1950 U.S. Census

Locations

Salt Lake FamilySearch Library
Find a Local FamilySearch Center

Industry

Affiliate Libraries
Archives
Developer Center
Solutions Gallery

About

Our Story
Data Privacy
Newsroom

FamilySearch Apps

Family Tree App
Memories App
Get Involved App
All Mobile Apps

Third-party Access

Ancestry
MyHeritage
FindMyPast
American Ancestors
Geneanet
All Third-parties
What We Offer
Family Tree
Genealogy Records
Family Photo Sharing
Family Activities
Learning Resources
Research Guidance
DNA Education
Surname Meanings
Ways to Contribute
Get Involved
Indexing
Volunteer
Donate
Guidance and Learning
Getting Started
RootsTech Conference
What's New
Learning Center
Genealogy Research Wiki
YouTube Channel
Free Virtual Consultations
Blog
Helpful Resources
Get Help
User Community
Help Center
Contact Us
Your Account
Suggest an Idea
Genealogy Resources
Obituaries
Cemeteries
FamilySearch Catalog
Ancestor Search
Genealogy Search
Place Names
Guided Research
Digital Books
1950 U.S. Census
Locations
Salt Lake FamilySearch Library
Find a Local FamilySearch Center
Industry
Affiliate Libraries
Archives
Developer Center
Solutions Gallery
About
Our Story
Data Privacy
Newsroom
FamilySearch Apps
Family Tree App
Memories App
Get Involved App
All Mobile Apps
Third-party Access
Ancestry
MyHeritage
FindMyPast
American Ancestors
Geneanet
All Third-parties

FamilySearch

Inspiring people everywhere to connect with their family—across generations. FamilySearch is an international nonprofit organization. Donate or volunteer today!

FamilySearch Terms of Use | Privacy Notice | Cookie Preferences | Site Map | Country and Language Options © 2025 by Intellectual Reserve, Inc. All rights reserved. A service provided by The Church of Jesus Christ of Latter-day Saints.

the church of jesus christ of latter day saints