Read Family Tree Collection

This example request illustrates how to read the FamilySearch Family Tree Collection. The Family Tree Collection resource contains all data, such as persons and relationships, in the FamilySearch Family Tree.

JSON

Request

GET /platform/collections/tree
Accept: application/x-gedcomx-v1+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

Response

HTTP/1.1 200 OK
Content-type: application/x-gedcomx-v1+json
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Content-location: /platform/collections/tree
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-transform, max-age=604800
Transfer-encoding: chunked{
  "links" : {
    "person-conclusion-template" : {
      "template" : "https://api.familysearch.org/tree/persons/{pid}/conclusions/{cid}?flag=fst"
    },
    "person-sources-query-template" : {
      "template" : "https://api.familysearch.org/tree/persons/{pid}/sources?flag=fst"
    },
    "child-and-parents-relationship-template" : {
      "template" : "https://api.familysearch.org/tree/child-and-parents-relationships/{caprid}?flag=fst"
    },
    "person-memories-query" : {
      "template" : "https://api.familysearch.org/tree/persons/{pid}/memories?flag=fst"
    },
    "child-and-parents-relationship-sources-template" : {
      "template" : "https://api.familysearch.org/tree/child-and-parents-relationships/{caprid}/sources?flag=fst"
    },
    "couple-relationship-conclusion-template" : {
      "template" : "https://api.familysearch.org/tree/couple-relationships/{crid}/conclusions/{cid}?flag=fst"
    },
    "couple-relationship-source-reference-template" : {
      "template" : "https://api.familysearch.org/tree/couple-relationships/{crid}/source-references/{srid}?flag=fst"
    },
    "agent-template" : {
      "template" : "https://api.familysearch.org/users/agents/{uid}?flag=fst"
    },
    "couple-relationship-sources-query-template" : {
      "template" : "https://api.familysearch.org/tree/couple-relationships/{crid}/sources?flag=fst"
    },
    "person-portrait-template" : {
      "template" : "https://api.familysearch.org/tree/persons/{pid}/portrait?flag=fst"
    },
    "couple-relationship-source-references-template" : {
      "template" : "https://api.familysearch.org/tree/couple-relationships/{crid}/source-references?flag=fst"
    },
    "couple-relationship-template" : {
      "template" : "https://api.familysearch.org/tree/couple-relationships/{crid}?flag=fst"
    }
  },
  "description" : "#SD-FSFT",
  "sourceDescriptions" : [ {
    "id" : "SD-FSFT",
    "about" : "#FSFT",
    "componentOf" : {
      "description" : "https://api.familysearch.org/platform/collection"
    },
    "resourceType" : "http://gedcomx.org/Collection",
    "titles" : [ {
      "value" : "FamilySearch Family Tree"
    } ]
  } ],
  "collections" : [ {
    "id" : "FSFT",
    "title" : "FamilySearch Family Tree",
    "links" : {
      "ancestry-query" : {
        "template" : "https://api.familysearch.org/tree/ancestry?flag=fst"
      },
      "current-user-history" : {
        "href" : "https://api.familysearch.org/users/user-id/history?flag=fsh"
      },
      "current-user-person" : {
        "href" : "https://api.familysearch.org/tree/current-person?flag=fsh"
      },
      "discussions" : {
        "href" : "https://api.familysearch.org/discussions/discussions?flag=fsh"
      },
      "collection" : {
        "href" : "https://api.familysearch.org/platform/collection?flag=fsh"
      },
      "http://oauth.net/core/2.0/endpoint/authorize" : {
        "href" : "https://api.familysearch.org/oauth2/v3/authorization?flag=fsh"
      },
      "source-references-query" : {
        "template" : "https://api.familysearch.org/tree/source-references?flag=fst"
      },
      "matches" : {
        "template" : "https://api.familysearch.org/tree/persons/{pid}/matches?flag=fst"
      },
      "person-matches-query" : {
        "template" : "https://api.familysearch.org/tree/matches?flag=fst"
      },
      "persons" : {
        "href" : "https://api.familysearch.org/tree/persons?flag=fsh"
      },
      "relationships" : {
        "href" : "https://api.familysearch.org/tree/relationships?flag=fsh"
      },
      "current-user" : {
        "href" : "https://api.familysearch.org/users/current?flag=fsh"
      },
      "logout" : {
        "href" : "https://api.familysearch.org/platform/logout?flag=fsh"
      },
      "preferred-parent-relationship" : {
        "template" : "https://api.familysearch.org/tree/users/{uid}/preferred-parent-relationships/{pid}?flag=fst"
      },
      "person" : {
        "template" : "https://api.familysearch.org/tree/persons/{pid}?flag=fst"
      },
      "source-descriptions" : {
        "href" : "https://api.familysearch.org/sources/descriptions?flag=fsh"
      },
      "person-match-resolutions-query" : {
        "href" : "https://api.familysearch.org/tree/match-resolutions?flag=fsh"
      },
      "preferred-spouse-relationship" : {
        "template" : "https://api.familysearch.org/tree/users/{uid}/preferred-spouse-relationships/{pid}?flag=fst"
      },
      "http://oauth.net/core/2.0/endpoint/token" : {
        "href" : "https://api.familysearch.org/oauth2/v3/token?flag=fsh"
      },
      "self" : {
        "href" : "https://api.familysearch.org/platform/collections/tree?flag=fsh"
      },
      "descendancy-query" : {
        "template" : "https://api.familysearch.org/tree/descendancy?flag=fst"
      },
      "person-search" : {
        "template" : "https://api.familysearch.org/tree/search?flag=fst"
      },
      "artifacts" : {
        "href" : "https://api.familysearch.org/memories/memories?flag=fsh"
      }
    }
  } ]
}

XML

Request

GET /platform/collections/tree
Accept: application/x-gedcomx-v1+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

Response

HTTP/1.1 200 OK
Content-type: application/x-gedcomx-v1+xml
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Content-location: /platform/collections/tree
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-transform, max-age=604800
Transfer-encoding: chunked<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<gedcomx xmlns:fs="http://familysearch.org/v1/" xmlns="http://gedcomx.org/v1/" xmlns:atom="http://www.w3.org/2005/Atom" description="#SD-FSFT">
    <link rel="agent-template" template="https://api.familysearch.org/users/agents/{uid}?flag=fst"/>
    <link rel="child-and-parents-relationship-sources-template" template="https://api.familysearch.org/tree/child-and-parents-relationships/{caprid}/sources?flag=fst"/>
    <link rel="child-and-parents-relationship-template" template="https://api.familysearch.org/tree/child-and-parents-relationships/{caprid}?flag=fst"/>
    <link rel="couple-relationship-conclusion-template" template="https://api.familysearch.org/tree/couple-relationships/{crid}/conclusions/{cid}?flag=fst"/>
    <link rel="couple-relationship-source-reference-template" template="https://api.familysearch.org/tree/couple-relationships/{crid}/source-references/{srid}?flag=fst"/>
    <link rel="couple-relationship-source-references-template" template="https://api.familysearch.org/tree/couple-relationships/{crid}/source-references?flag=fst"/>
    <link rel="couple-relationship-sources-query-template" template="https://api.familysearch.org/tree/couple-relationships/{crid}/sources?flag=fst"/>
    <link rel="couple-relationship-template" template="https://api.familysearch.org/tree/couple-relationships/{crid}?flag=fst"/>
    <link rel="person-conclusion-template" template="https://api.familysearch.org/tree/persons/{pid}/conclusions/{cid}?flag=fst"/>
    <link rel="person-memories-query" template="https://api.familysearch.org/tree/persons/{pid}/memories?flag=fst"/>
    <link rel="person-portrait-template" template="https://api.familysearch.org/tree/persons/{pid}/portrait?flag=fst"/>
    <link rel="person-sources-query-template" template="https://api.familysearch.org/tree/persons/{pid}/sources?flag=fst"/>
    <sourceDescription about="#FSFT" resourceType="http://gedcomx.org/Collection" id="SD-FSFT">
        <componentOf description="https://api.familysearch.org/platform/collection"/>
        <title>FamilySearch Family Tree</title>
    </sourceDescription>
    <collection id="FSFT">
        <link rel="ancestry-query" template="https://api.familysearch.org/tree/ancestry?flag=fst"/>
        <link rel="artifacts" href="https://api.familysearch.org/memories/memories?flag=fsh"/>
        <link rel="collection" href="https://api.familysearch.org/platform/collection?flag=fsh"/>
        <link rel="current-user-history" href="https://api.familysearch.org/users/user-id/history?flag=fsh"/>
        <link rel="current-user-person" href="https://api.familysearch.org/tree/current-person?flag=fsh"/>
        <link rel="current-user" href="https://api.familysearch.org/users/current?flag=fsh"/>
        <link rel="descendancy-query" template="https://api.familysearch.org/tree/descendancy?flag=fst"/>
        <link rel="discussions" href="https://api.familysearch.org/discussions/discussions?flag=fsh"/>
        <link rel="http://oauth.net/core/2.0/endpoint/authorize" href="https://api.familysearch.org/oauth2/v3/authorization?flag=fsh"/>
        <link rel="http://oauth.net/core/2.0/endpoint/token" href="https://api.familysearch.org/oauth2/v3/token?flag=fsh"/>
        <link rel="logout" href="https://api.familysearch.org/platform/logout?flag=fsh"/>
        <link rel="matches" template="https://api.familysearch.org/tree/persons/{pid}/matches?flag=fst"/>
        <link rel="person-match-resolutions-query" href="https://api.familysearch.org/tree/match-resolutions?flag=fsh"/>
        <link rel="person-matches-query" template="https://api.familysearch.org/tree/matches?flag=fst"/>
        <link rel="person-search" template="https://api.familysearch.org/tree/search?flag=fst"/>
        <link rel="person" template="https://api.familysearch.org/tree/persons/{pid}?flag=fst"/>
        <link rel="persons" href="https://api.familysearch.org/tree/persons?flag=fsh"/>
        <link rel="preferred-parent-relationship" template="https://api.familysearch.org/tree/users/{uid}/preferred-parent-relationships/{pid}?flag=fst"/>
        <link rel="preferred-spouse-relationship" template="https://api.familysearch.org/tree/users/{uid}/preferred-spouse-relationships/{pid}?flag=fst"/>
        <link rel="relationships" href="https://api.familysearch.org/tree/relationships?flag=fsh"/>
        <link rel="self" href="https://api.familysearch.org/platform/collections/tree?flag=fsh"/>
        <link rel="source-descriptions" href="https://api.familysearch.org/sources/descriptions?flag=fsh"/>
        <link rel="source-references-query" template="https://api.familysearch.org/tree/source-references?flag=fst"/>
        <title>FamilySearch Family Tree</title>
    </collection>
</gedcomx>