Example Requests

Artifacts

No example requests have been provided.

Authentication

Delete Access Token	How to invalidate an access token.
Initiate Authorization (Invalid Parameter)	Example illustrating the result of invalid parameters when initiating the process for obtaining an OAuth 2 authorization code.
Obtain Access Token (Bad Parameters)	Example of invalid parameters when exchanging the authorization code for an access token.
Obtain Access Token with Username and Password	How to exchange a user's username and password for an access token.
Obtain Access Token without Authenticating	How to obtain an access token without authenticating.

Authorities

No example requests have been provided.

Change History

Read Child-and-Parents Relationship Change History	How to get the change history for a child-and-parents relationship.
Read Couple Relationship Change History	How to get the change history for the relationship.
Read Person Change History	How to get a change history.
Read Person Change History First Ten Entries	How to read the first ten entries of a change history for a person.
Restore Change Action	How to restore a change from the change history.

Collections

Read Controlled Vocabulary	How to read a FamilySearch Controlled Vocabulary resource.
Read Date Authority	How to read the FamilySearch Date Authority resource.
Read Discussions Collection	How to read the FamilySearch Discussions Collection resource.
Read Family Tree Collection	How to read the FamilySearch Family Tree Collection resource.
Read FamilySearch Collections	How to read the list of all collections described by the FamilySearch API.
Read Genealogies Collection	How to read the FamilySearch Genealogies Collection resource.
Read Memories Collection	How to read the FamilySearch Memories Collection resource.
Read Place Authority	How to read the FamilySearch Place Authority resource.
Read Root Collection	How to read the FamilySearch Root Collection resource.
Read User-Defined Sources Collection	How to read the FamilySearch User-Defined Sources Collection resource.

Discussions

Create Comment	How to add a comment to a discussion.
Create Discussion	How to create a discussion.
Delete Comment	How to delete a comment.
Read Comments	How to read the comments of a discussion.
Read Discussion	How to read a discussion.
Update Comment	How to update a comment.
Update Discussion	How to update a discussion.

Genealogies

Create Genealogies Person	How to create a person.
Create Genealogies Relationship Conclusion	How to create a relationship conclusion.
Create Genealogies Source Description	How to create a source description.
Create Genealogies Tree	How to create a tree.
Delete Genealogies Conclusion	How to delete a conclusion resource.
Delete Genealogies Person	How to delete a person.
Delete Genealogies Person With Preconditions	How to do a conditional delete of a person.
Delete Genealogies Relationship	How to delete a relationship resource.
Delete Genealogies Source Description	How to delete a source description.
Delete Genealogies Tree	How to delete a genealogies tree.
Head Genealogies Person	How to read the headers for a person.
Read Genealogies Deleted Person	Example illustrating what happens during a read of person that has been deleted.
Read Genealogies Merged Person	Example illustrating what happens during a read of a person that has been merged.
Read Genealogies Not Modified Person	How to conditionally read a person that hasn't been modified.
Read Genealogies Person	How to read a person.
Read Genealogies Source Description	How to read a source description.
Read Genealogies Tree	How to read a tree.
Read Genealogies Trees	How to get the genealogy trees created by the current user.
Read Matches by Genealogies Person Id	How to get the record matches for a genealogies person id.
Read Page of the Genealogies Persons in a Tree	How to read a page of persons in tree.
Restore Genealogies Person	How to un-delete or restore a person resource that has been deleted.
Update Genealogies Person	How to make changes to a person.
Update Genealogies Source Description	How to update a source description.
Update Genealogies Tree	How to update a genealogies tree with new persons and relationships.

Groups

No example requests have been provided.

Memories

Create Memories Comment	How to create a comment on a memory.
Create Memory Persona	How to create a persona on a memory.
Create User-Uploaded Source	How to create a source for an artifact that a user has uploaded.
Delete Memories Comment	How to delete a comment on a memory.
Delete Memory	How to delete a memory.
Delete Memory Artifact Coverage	How to delete a memory artifact coverage resource.
Delete Memory Persona	How to delete a memory persona.
Read Memories Comments	How to read the comments of users on a memory.
Read Memories for a User	How to query for all memories for a user.
Read Memory	How to read a memory.
Read Memory Persona	How to read a memory persona.
Read Memory Personas	How to read the personas of a memory.
Update Memory Description	How to update a description of a memory.
Update Memory Persona	How to update a memory persona.
Update Story	How to update the text of a story.
Update Story Via Multipart Form Data	How to update the text of a story via multipart/form-data.
Upload Image as a Document	How to upload an image as a document.
Upload Multiple Photo Memories	How to upload multiple photo memories using a multipart request.
Upload PDF Document	How to upload a PDF document.
Upload Photo	How to upload a photo.
Upload Photo Via Multipart Form Data	How to upload a photo via multipart form data.
Upload Story	How to upload a story.
Upload Story Memories	How to upload multiple stories using a multipart request.

Names

Parse Segments	How to compose a full name from its parts.
Read name script	How to get a name's script.
Read name segments	How to get a name's segments.

Ordinances

No example requests have been provided.

Parents and Children

Create Child and Parents Relationship	How to create a child and parents relationship.
Create Child-and-Parents Relationship Conclusion	How to add a fact on a child-and-parents relationship.
Create Child-and-Parents Relationship Note	How to create a note on a child-and-parents relationship.
Create Child-and-Parents Relationship Source Reference	How to create a source reference for a child-and-parents relationship.
Create Couple Relationship	How to create a couple relationship.
Delete Child-and-Parents Relationship	How to delete a child-and-parents relationship.
Delete Child-and-Parents Relationship Conclusion	How to delete a fact on a child-and-parents relationship.
Delete Child-and-Parents Relationship Note	How to delete a note on a child-and-parents relationship.
Delete Child-and-Parents Relationship Parent	How to remove a parent from a child-and-parents relationship.
Delete Child-and-Parents Relationship Source Reference	How to delete a source reference on a child-and-parents relationship.
Read Child-and-Parents Relationship	How to get a child-and-parents relationship.
Read Child-and-Parents Relationship Change History	How to get the change history for a child-and-parents relationship.
Read Child-and-Parents Relationship Note	How to read a note on a child-and-parents relationship.
Read Child-and-Parents Relationship Notes	How to get a list of notes on a child-and-parents relationship.
Read Child-and-Parents Relationship Source References	How to get a list of source reference resources for a child-and-parents relationship.
Read Child-and-Parents Relationship Sources	How to query for the list of sources on a child-and-parents relationship.
Restore Child-and-Parents Relationship	How to un-delete or restore a child-and-parents relationship that has been deleted.
Set Child-and-Parents Relationship Parents Ordering	How to set the child-and-parents relationship parents ordering.
Update Child-and-Parents Relationship	How to update a child-and-parents relationship.
Update Child-and-Parents Relationship Conclusion	How to update a fact on a child-and-parents relationship.
Update Child-and-Parents Relationship Note	How to update a note on a child-and-parents relationship.

Pedigree

Read Person Ancestry	How to read the ancestry graph for a person.
Read Person Ancestry and additional person details	How to read the ancestry for a person and return additional person details.
Read Person Ancestry with Specified Spouse	How to read the ancestry graph for a person with a specified spouse.
Read Person Ancestry with Specified Spouse and additional person and marriage details	How to read the ancestry graph for a person with a specified spouse and return additional person details and marriage details.
Read Person Descendancy	How to get the descendancy for a person.
Read Person Descendancy and additional person and marriage details	How to get the descendancy for a person and return additional person details and marriage details.

Person

Create Discussion Reference	How to attach a discussion to a person.
Create Note	How to create a note on a person.
Create Person	How to create a person.
Create Person Conclusion	How to create a conclusion.
Create Person Life Sketch	How to create a life sketch for a person.
Create Person Source Reference	How to create a source reference on a person.
Delete Discussion Reference	How to delete a discussion resource.
Delete Note	How to delete a note.
Delete Person	How to delete a person.
Delete Person Conclusion	How to delete a conclusion resource.
Delete Person Memory Reference	How to delete a reference from a Tree person to a memory persona.
Delete Person Not-a-Match Declarations	How to delete person-not-a-match declarations for specific persons.
Delete Person Portrait Selection	How to delete the portrait selection of a user for a person.
Delete Person Source Reference	How to delete a source reference.
Delete Person With Preconditions	How to do a conditional delete of a person.
Delete Preferred Parent Relationship	How to delete a user's preferred parent relationship for a person.
Delete Preferred Spouse Relationship	How to delete a user's preferred spouse relationship for a person.
Head Person	How to read the headers for a person.
Merge Person	How to merge two persons.
Read Children of a Person	How to read the list of children of a person.
Read Current Tree Person	How to query for the Tree person that represents the current user.
Read Current Tree Person Expecting 200 Response	How to query for the Tree person that represents the current user and specify that you expect a 200 OK response code instead of a 303 See Other response code.
Read Deleted Person	Example illustrating what happens during a read of person that has been deleted.
Read Families of a Person	How to read the families of a person.
Read Merged Person	Example illustrating what happens during a read of a person that has been merged.
Read Not Found Person	Example illustrating what happens during a read of a person that doesn't exist.
Read Not Modified Person	How to conditionally read a person that hasn't been modified.
Read Note	How to read a note on a person.
Read Notes	How to read the list of notes on a person.
Read Parents of a Person	How to read the list of parents of a person, including any couple relationships of the parents.
Read Person	How to read a person.
Read Person Change History	How to get a change history.
Read Person Change History First Ten Entries	How to read the first ten entries of a change history for a person.
Read Person Memories	How to read all the memories linked to a person.
Read Person Memories By Type	How to read the memories linked to a person for a particular set of artifact types.
Read Person Merge Analysis	How to read an analysis for a merge of two persons.
Read Person Merge Constraint (Can Merge Any Order)	How to read the constraints for a merge between two persons that can be merged in either order.
Read Person Merge Constraint (Can Merge Other Order Only)	How to read the constraints for a merge between two persons that can be merged only in the other order.
Read Person Not-A-Match Declarations	How to read the persons that have been designated as not a match for a specific person.
Read Person Portrait	How to read a portrait for a person.
Read Person Portrait With Default	How to read a portrait for a person with a default image.
Read Person Portraits	How to read the portraits linked to a person.
Read Person Sources	How to query for the list of sources on a person.
Read Persons	How to read multiple persons.
Read Preferred Parent Relationship	How to read a user's preferred parent relationship for a person.
Read Preferred Spouse Relationship	How to read a user's preferred spouse relationship for a person.
Read Spouses of a Person	How to read the spouses of a person.
Read Spouses of a Person but no Relationship	How to read the spouses of a person but no Relationship is returned.
Restore Person	How to un-delete or restore a person resource that has been deleted.
Update Note	How to update a note.
Update Person Conclusion	How to update a conclusion resource.
Update Person Custom Non-Event Fact	How to update a custom fact that is designated as "not an event" in the Family Tree.
Update Person Life Sketch	How to create a life sketch for a person.
Update Person Not-a-Match Declarations	How to designate persons as not a match for a specific person.
Update Person Portraits	How to create the portrait linked to a person.
Update Person Source Reference	How to update a source reference on a person.
Update Person With Preconditions	How to do a conditional update of a person.
Update Preferred Parent Relationship	How to set a user's preferred parent relationship for a person.
Update Preferred Spouse Relationship	How to set a user's preferred spouse relationship for a person.
Upload Photo for Person	How to upload a photo for a Family Tree person.

Places

Read Place Description	How to get a place description.
Read Place Description Attributes	How to get the attributes of a place description.
Read Place Description Children	How to get the children of a place description.
Read Place Descriptions	How to get a list of place descriptions.
Read Place Descriptions Group	How to read a place descriptions group.
Read Place Type	How to get a place type.
Read Place Type Group	How to get a place type group.
Read Place Type Groups	How to get the list of place type groups.
Read Place Types	How to get the list of place types.
Search For Places	How to search for a place.
Search For Places Directly Under a Jurisdiction	How to search for a place, requiring results to be limited to those directly under a specific jurisdiction.
Search For Places Under a Jurisdiction	How to search for a place, requiring results to be limited to those directly or indirectly under a specific jurisdiction.

Records

No example requests have been provided.

Search and Match

Delete Person Not-a-Match Declarations	How to delete person-not-a-match declarations for specific persons.
Read Matches by Tree Person Id	How to get the record matches for a tree person id.
Read Matches by Tree Person Id for All Match Status Types	How to get the record matches for a tree person id for all types of match statuses.
Read Matches by Tree Person Id with Higher Confidence	How to get the record matches for a tree person id with higher confidence that are accepted.
Read Person Matches using Gedcomx	How to request matches for a person using a Gedcomx document.
Read Person Matches using query	How to request matches for a person using query parameters.
Read Person Not-A-Match Declarations	How to read the persons that have been designated as not a match for a specific person.
Read Person Possible Duplicates	How to get the possible duplicates for a person.
Search for tree persons - first page	How to get the first page of tree person search results.
Search for tree persons - next page	How to get the next page (and by extension, subsequent pages) of tree person search results..
Search for tree persons with cardinality and modifier.	How to search for tree persons using cardinality and modifiers.
Search for tree persons with wildcard characters	How to search for tree persons using wildcard characters in the search parameter values.
Update Match Status by Tree Person Id for Record Matches	How to designate a match status for record matches of a tree person id.
Update Person Not-a-Match Declarations	How to designate persons as not a match for a specific person.

Sources

Create Source Description	How to create a source description.
Create Source Folder	How to create a source folder.
Create User-Uploaded Source	How to create a source for an artifact that a user has uploaded.
Delete Source Description	How to delete a source description.
Delete Source Descriptions from a Folder	How to remove source descriptions from a folder.
Delete Source Folder	How to delete a source folder.
Move Sources to a Folder	How to move source descriptions to a folder.
Read a Page of the Sources in a Folder	How to read a page of sources in folder.
Read Source Description	How to read a source description.
Read Source Folder	How to read a source folder.
Read Source References	How to query for the source references that refer to a given source.
Read User Source Descriptions	How to read all source descriptions provided by a specific user.
Read User Source Folders	How to read the list of a user's source folders.
Update Source Description	How to update a source description.
Update Source Folder	How to update a source folder.

Spouses

Create Child and Parents Relationship	How to create a child and parents relationship.
Create Couple Relationship	How to create a couple relationship.
Create Couple Relationship Conclusion	How to add a conclusion to a couple relationship.
Create Couple Relationship Note	How to create a note on a relationship.
Create Couple Relationship Source Reference	How to create a source reference resource.
Delete Couple Relationship	How to delete a couple resource.
Delete Couple Relationship Conclusion	How to delete a conclusion on a couple relationship.
Delete Couple Relationship Note	How to delete a note on a couple relationship.
Delete Couple Relationship Source Reference	How to delete a source reference resource.
Head Couple Relationship	How to get the couple resource headers.
Read Couple Relationship	How to get a couple resource.
Read Couple Relationship (Conditional)	Example illustrating how the caching mechanism works on the couple using the Etag header.
Read Couple Relationship Change History	How to get the change history for the relationship.
Read Couple Relationship Note	How to read a note on a couple relationship.
Read Couple Relationship Notes	How to get a list of notes on a couple relationship.
Read Couple Relationship Source References	How to get a list of source reference resources.
Read Couple Relationship Sources	How to query for the list of sources on a couple relationship.
Read Non-Existent Couple Relationship	Example illustrating a request for a couple that doesn't exist.
Restore Couple Relationship	How to un-delete or restore a couple relationship that has been deleted.
Set Couple Relationship Spouses Ordering	How to set the couple relationship spouses ordering.
Update Couple Relationship Conclusion	How to update a conclusion on a couple relationship.
Update Couple Relationship Note	How to update a note on a couple relationship.
Update Couple Relationship Notes	How to update a note on a couple relationship.
Update Illegal Couple Relationship	Update the persons that are associated by a couple relationship, triggering the gender constraint.
Update Persons of a Couple Relationship	How to update the persons that are associated by a couple relationship.

Trees

No example requests have been provided.

User

Read Current Tree Person	How to query for the Tree person that represents the current user.
Read Current Tree Person Expecting 200 Response	How to query for the Tree person that represents the current user and specify that you expect a 200 OK response code instead of a 303 See Other response code.
Read Current User	How to query for the current user.
Read User	How to read a contributor.

Utilities

Read Person With Multiple Pending Modifications Activated	How to read a person with multiple pending modifications activated.
Read Person With Pending Modification Activated	How to read a person with a pending modification activated.

Vocabularies

Read Vocabulary List	How to get vocabulary list.
Read Vocabulary Term	How to get a vocabulary term.
Read Vocabulary Term, Alternate Language	How to get a vocabulary term in a different language.