Read Root Collection

This example request illustrates how to read the FamilySearch Root Collection. The Root Collection resource contains all data provided by FamilySearch.

JSON

Request

GET /platform/collection
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
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-transform, max-age=604800
Transfer-encoding: chunked{
  "links" : {
    "registration" : {
      "href" : "https://familysearch.org/registration",
      "title" : "User Registration"
    }
  },
  "description" : "#FS",
  "sourceDescriptions" : [ {
    "id" : "FS",
    "titles" : [ {
      "value" : "FamilySearch.org"
    } ]
  } ],
  "collections" : [ {
    "title" : "FamilySearch.org",
    "links" : {
      "subcollections" : {
        "href" : "https://api.familysearch.org/platform/collections?flag=fsh"
      },
      "current-user" : {
        "href" : "https://api.familysearch.org/users/current?flag=fsh"
      },
      "logout" : {
        "href" : "https://api.familysearch.org/platform/logout?flag=fsh"
      },
      "places" : {
        "href" : "https://api.familysearch.org/platform/collections/places?flag=fsh"
      },
      "source-box" : {
        "href" : "https://api.familysearch.org/platform/collections/sources?flag=fsh"
      },
      "discussions" : {
        "href" : "https://api.familysearch.org/platform/collections/discussions?flag=fsh"
      },
      "http://oauth.net/core/2.0/endpoint/token" : {
        "href" : "https://api.familysearch.org/oauth2/v3/token?flag=fsh"
      },
      "memories" : {
        "href" : "https://api.familysearch.org/platform/collections/memories?flag=fsh"
      },
      "vocab" : {
        "href" : "https://api.familysearch.org/platform/collections/vocab?flag=fsh"
      },
      "family-tree" : {
        "href" : "https://api.familysearch.org/platform/collections/tree?flag=fsh"
      },
      "http://oauth.net/core/2.0/endpoint/authorize" : {
        "href" : "https://api.familysearch.org/oauth2/v3/authorization?flag=fsh"
      },
      "pending-modifications" : {
        "href" : "https://api.familysearch.org/platform/pending-modifications?flag=fsh"
      }
    }
  } ]
}

XML

Request

GET /platform/collection
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
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="#FS">
    <link rel="registration" href="https://familysearch.org/registration" title="User Registration"/>
    <sourceDescription id="FS">
        <title>FamilySearch.org</title>
    </sourceDescription>
    <collection>
        <link rel="current-user" href="https://api.familysearch.org/users/current?flag=fsh"/>
        <link rel="discussions" href="https://api.familysearch.org/platform/collections/discussions?flag=fsh"/>
        <link rel="family-tree" href="https://api.familysearch.org/platform/collections/tree?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="memories" href="https://api.familysearch.org/platform/collections/memories?flag=fsh"/>
        <link rel="pending-modifications" href="https://api.familysearch.org/platform/pending-modifications?flag=fsh"/>
        <link rel="places" href="https://api.familysearch.org/platform/collections/places?flag=fsh"/>
        <link rel="source-box" href="https://api.familysearch.org/platform/collections/sources?flag=fsh"/>
        <link rel="subcollections" href="https://api.familysearch.org/platform/collections?flag=fsh"/>
        <link rel="vocab" href="https://api.familysearch.org/platform/collections/vocab?flag=fsh"/>
        <title>FamilySearch.org</title>
    </collection>
</gedcomx>