FamilySearch API

https://www.familysearch.org/en/developers/docs/api/
Admin
FamilySearch API is a RESTful web service that provides access to genealogical data including family...
Tokens:617,527
Snippets:3,263
Trust Score:9.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Get Children of a Place Description (XML)

Source: https://www.familysearch.org/en/developers/docs/api/places/Read_Place_Description_Children_usecase

This example demonstrates how to fetch the children of a place description using a GET request. The `Accept` header specifies the desired XML format.

```APIDOC
## GET /platform/places/description/{id}/children

### Description
Retrieves a list of child places for a given place description ID in XML format.

### Method
GET

### Endpoint
/platform/places/description/{id}/children

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the place description for which to retrieve children.

#### Headers
- **Accept**: application/x-fs-v1+xml
- **Authorization**: Bearer YOUR_ACCESS_TOKEN_HERE

### Response
#### Success Response (200)
- The response will be in XML format, containing a list of place elements, each with an `id`, `link`, and `name` elements.

### Request Example
```
GET /platform/places/description/1/children
Accept: application/x-fs-v1+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
```

### Response Example
```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<fs:familysearch xmlns:fs="http://familysearch.org/v1/" xmlns="http://gedcomx.org/v1/" xmlns:atom="http://www.w3.org/2005/Atom">
    <place id="351">
        <link rel="description" href="https://api.familysearch.org/platform/places/description/351?flag=fsh"/>
        <name xml:lang="en">Alabama</name>
        <name xml:lang="zh-Kana">アラバマ州</name>
    </place>
    <place id="350">
        <link rel="description" href="https://api.familysearch.org/platform/places/description/350?flag=fsh"/>
        <name xml:lang="en">Alaska</name>
        <name xml:lang="zh-Kana">アラスカ州</name>
    </place>
</fs:familysearch>
```
```

--------------------------------

### Get Person Sources

Source: https://www.familysearch.org/en/developers/docs/api/tree/Read_Person_Sources_usecase

This example request illustrates how to query for the list of sources on a person. You will get the person's source references as well as the source descriptions for those sources.

```APIDOC
## GET /platform/tree/persons/PPPP-PPP/sources

### Description
Retrieves a list of sources associated with a specific person, including source references and descriptions.

### Method
GET

### Endpoint
/platform/tree/persons/{personId}/sources

### Parameters
#### Path Parameters
- **personId** (string) - Required - The unique identifier of the person.

#### Headers
- **Accept**: application/x-gedcomx-v1+json
- **Authorization**: Bearer YOUR_ACCESS_TOKEN_HERE

### Response
#### Success Response (200)
- **sourceReferences** (array) - A list of source references for the person.
- **sourceDescriptions** (array) - A list of descriptions for the sources.

### Response Example
{
  "sourceReferences": [
    {
      "description": {
        "resource": "#sourceDescription1"
      }
    }
  ],
  "sourceDescriptions": [
    {
      "id": "sourceDescription1",
      "about": "http://example.com/source1"
    }
  ]
}
```

--------------------------------

### Get Couple Relationship Sources

Source: https://www.familysearch.org/en/developers/docs/api/tree/Read_Couple_Relationship_Sources_usecase

This example request illustrates how to query for the list of sources on a couple relationship.

```APIDOC
## GET /platform/tree/couple-relationships/{coupleRelationshipId}/sources

### Description
Retrieves a list of sources associated with a specific couple relationship.

### Method
GET

### Endpoint
/platform/tree/couple-relationships/CCCC-CCC/sources

### Headers
- Accept: application/x-gedcomx-v1+json
- Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
```

--------------------------------

### Get Children of a Place Description (JSON)

Source: https://www.familysearch.org/en/developers/docs/api/places/Read_Place_Description_Children_usecase

This example demonstrates how to fetch the children of a place description using a GET request. The `Accept` header specifies the desired JSON format.

```APIDOC
## GET /platform/places/description/{id}/children

### Description
Retrieves a list of child places for a given place description ID.

### Method
GET

### Endpoint
/platform/places/description/{id}/children

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the place description for which to retrieve children.

#### Headers
- **Accept**: application/x-fs-v1+json
- **Authorization**: Bearer YOUR_ACCESS_TOKEN_HERE

### Response
#### Success Response (200)
- **places** (array) - A list of place objects, each containing an `id`, `links`, and `names`.
  - **id** (string) - The unique identifier for the child place.
  - **links** (object) - Contains links related to the place description.
    - **description** (object) - Link to the description of the child place.
      - **href** (string) - The URL for the place description.
  - **names** (array) - A list of names for the place in different languages.
    - **lang** (string) - The language code for the name.
    - **value** (string) - The name of the place in the specified language.

### Request Example
```
GET /platform/places/description/1/children
Accept: application/x-fs-v1+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
```

### Response Example
```json
{
  "places" : [ {
    "id" : "351",
    "links" : {
      "description" : {
        "href" : "https://api.familysearch.org/platform/places/description/351?flag=fsh"
      }
    },
    "names" : [ {
      "lang" : "en",
      "value" : "Alabama"
    }, {
      "lang" : "zh-Kana",
      "value" : "アラバマ州"
    } ]
  }, {
    "id" : "350",
    "links" : {
      "description" : {
        "href" : "https://api.familysearch.org/platform/places/description/350?flag=fsh"
      }
    },
    "names" : [ {
      "lang" : "en",
      "value" : "Alaska"
    }, {
      "lang" : "zh-Kana",
      "value" : "アラスカ州"
    } ]
  } ]
}
```
```

--------------------------------

### Get Place Types (JSON)

Source: https://www.familysearch.org/en/developers/docs/api/places/Read_Place_Types_usecase

This example demonstrates how to fetch the list of place types using a GET request with an Accept header for JSON.

```APIDOC
## GET /platform/places/types

### Description
Retrieves a list of all available place types.

### Method
GET

### Endpoint
/platform/places/types

### Headers
- Accept: application/ld+json
- Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

### Response
#### Success Response (200 OK)
- Content-type: application/ld+json
- Body: A JSON object containing a list of place types, each with an ID, labels, and descriptions.

### Response Example
```json
{
  "@id" : "https://api.familysearch.org/platform/places/types",
  "title" : "Place Type List Title",
  "description" : "Place Type List Description",
  "elements" : [ {
    "id" : "1",
    "@id" : "https://api.familysearch.org/platform/places/types/1",
    "labels" : [ {
      "@language" : "en",
      "@value" : "Place Type 1 Title"
    } ],
    "descriptions" : [ {
      "@language" : "en",
      "@value" : "Place Type 1 Description"
    } ]
  }, {
    "id" : "2",
    "@id" : "https://api.familysearch.org/platform/places/types/2",
    "labels" : [ {
      "@language" : "en",
      "@value" : "Place Type 2 Title"
    } ],
    "descriptions" : [ {
      "@language" : "en",
      "@value" : "Place Type 2 Description"
    } ]
  } ],
  "http://www.w3.org/1999/02/22-rdf-syntax-ns#_1" : {
    "@id" : "https://api.familysearch.org/platform/places/types/1"
  },
  "http://www.w3.org/1999/02/22-rdf-syntax-ns#_2" : {
    "@id" : "https://api.familysearch.org/platform/places/types/2"
  },
  "@context" : {
    "title" : "http://purl.org/dc/terms/title",
    "description" : "http://purl.org/dc/terms/description",
    "elements" : {
      "@id" : "http://purl.org/dc/terms/hasPart",
      "@container" : "@list"
    },
    "id" : {
      "@id" : "http://purl.org/dc/terms/identifier"
    },
    "subclassOf" : {
      "@id" : "http://www.w3.org/2000/01/rdf-schema#subClassOf",
      "@type" : "@id"
    },
    "references" : {
      "@id" : "http://purl.org/dc/terms/references",
      "@type" : "@id"
    },
    "type" : {
      "@id" : "http://purl.org/dc/terms/type",
      "@type" : "@id"
    },
    "labels" : {
      "@id" : "http://www.w3.org/2000/01/rdf-schema#label"
    },
    "descriptions" : {
      "@id" : "http://www.w3.org/2000/01/rdf-schema#comment"
    }
  }
}
```
```

--------------------------------

### Read User Source Descriptions (XML)

Source: https://www.familysearch.org/en/developers/docs/api/sources/Read_User_Source_Descriptions_usecase

This example demonstrates how to fetch source descriptions in XML format for a given user. The `start` and `count` parameters control pagination.

```APIDOC
## GET /platform/sources/{sourceId}/collections/descriptions

### Description
Retrieves a paged list of source descriptions provided by a specific user in XML format.

### Method
GET

### Endpoint
/platform/sources/{sourceId}/collections/descriptions

### Parameters
#### Query Parameters
- **start** (integer) - Optional - The starting index for the results.
- **count** (integer) - Optional - The number of results to return per page.

### Request Example
```http
GET /platform/sources/CCCC-CCC/collections/descriptions?start=2&count=1
Accept: application/x-fs-v1+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
```
```

--------------------------------

### Get Memories for a User (XML)

Source: https://www.familysearch.org/en/developers/docs/api/memories/Read_Memories_for_a_User_usecase

This example demonstrates how to fetch memories for a user in XML format. It includes query parameters for pagination and requires an Authorization header.

```APIDOC
## GET /platform/memories/users/{userId}/memories

### Description
Retrieves a list of memories associated with a specific user in XML format.

### Method
GET

### Endpoint
/platform/memories/users/cis.user.batman/memories

### Query Parameters
- **start** (integer) - Optional - The starting index for the memory list.
- **count** (integer) - Optional - The number of memories to retrieve.

### Headers
- **Accept**: application/x-fs-v1+xml
- **Authorization**: Bearer YOUR_ACCESS_TOKEN_HERE

### Response Example (200 OK)
```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<fs:familysearch xmlns:fs="http://familysearch.org/v1/" xmlns="http://gedcomx.org/v1/" xmlns:atom="http://www.w3.org/2005/Atom">
    <link rel="first" href="https://api.familysearch.org/platform/memories/users/cis.user.batman/memories?flag=fsh&amp;count=1&amp;start=0"/>
    <link rel="next" href="https://api.familysearch.org/platform/memories/users/cis.user.batman/memories?flag=fsh&amp;count=1&amp;start=3"/>
    <link rel="prev" href="https://api.familysearch.org/platform/memories/users/cis.user.batman/memories?flag=fsh&amp;count=1&amp;start=1"/>
    <link rel="self" href="https://api.familysearch.org/platform/memories/users/cis.user.batman/memories?flag=fsh&amp;count=1&amp;start=2"/>
    <sourceDescription id="MMMM-PPP">
        <link rel="comments" href="https://api.familysearch.org/platform/memories/memories/MMMM-PPP/comments?flag=fsh"/>
        <link rel="memory" href="https://api.familysearch.org/platform/memories/memories/MMMM-PPP?flag=fsh"/>
        <title>NEW ARTIFACT TITLE</title>
    </sourceDescription>
</fs:familysearch>
```
```

--------------------------------

### Get Memories for a User (JSON)

Source: https://www.familysearch.org/en/developers/docs/api/memories/Read_Memories_for_a_User_usecase

This example demonstrates how to fetch memories for a user in JSON format. It includes query parameters for pagination and requires an Authorization header.

```APIDOC
## GET /platform/memories/users/{userId}/memories

### Description
Retrieves a list of memories associated with a specific user.

### Method
GET

### Endpoint
/platform/memories/users/cis.user.batman/memories

### Query Parameters
- **start** (integer) - Optional - The starting index for the memory list.
- **count** (integer) - Optional - The number of memories to retrieve.

### Headers
- **Accept**: application/x-fs-v1+json
- **Authorization**: Bearer YOUR_ACCESS_TOKEN_HERE

### Response Example (200 OK)
```json
{
  "links" : {
    "next" : {
      "href" : "https://api.familysearch.org/platform/memories/users/cis.user.batman/memories?flag=fsh&count=1&start=3"
    },
    "prev" : {
      "href" : "https://api.familysearch.org/platform/memories/users/cis.user.batman/memories?flag=fsh&count=1&start=1"
    },
    "self" : {
      "href" : "https://api.familysearch.org/platform/memories/users/cis.user.batman/memories?flag=fsh&count=1&start=2"
    },
    "first" : {
      "href" : "https://api.familysearch.org/platform/memories/users/cis.user.batman/memories?flag=fsh&count=1&start=0"
    }
  },
  "sourceDescriptions" : [ {
    "id" : "MMMM-PPP",
    "links" : {
      "comments" : {
        "href" : "https://api.familysearch.org/platform/memories/memories/MMMM-PPP/comments?flag=fsh"
      },
      "memory" : {
        "href" : "https://api.familysearch.org/platform/memories/memories/MMMM-PPP?flag=fsh"
      }
    },
    "titles" : [ {
      "value" : "NEW ARTIFACT TITLE"
    } ]
  } ]
}
```
```

--------------------------------

### Get Name Segments

Source: https://www.familysearch.org/en/developers/docs/api/names/Read_name_segments_usecase

This example request illustrates how to get the segments of a name from the full text and possibly transliterate the name as well.

```APIDOC
## GET /platform/names/segments

### Description
Retrieves segments of a name from the full text and optionally transliterates the name.

### Method
GET

### Endpoint
/platform/names/segments

### Parameters
#### Query Parameters
- **fullName** (string) - Required - The full name to segment.
- **lang** (string) - Optional - The language code for transliteration (e.g., 'ja').

#### Headers
- **Accept**: application/x-gedcomx-v1+json
- **Authorization**: Bearer YOUR_ACCESS_TOKEN_HERE
- **Accept-Language**: en

### Response
#### Success Response (200)
- **persons** (array) - Contains a list of persons, each with their names and name forms.
  - **names** (array) - A list of names for the person.
    - **nameForms** (array) - A list of name forms, including language, full text, and parts.
      - **lang** (string) - The language of the name form (e.g., 'ja-Latn').
      - **fullText** (string) - The full text of the name in the specified form.
      - **parts** (array) - An array of name parts, each with a type and value.
        - **type** (string) - The type of the name part (e.g., 'http://gedcomx.org/Given', 'http://gedcomx.org/Surname').
        - **value** (string) - The value of the name part.

### Response Example
```json
{
  "persons" : [
    {
      "names" : [
        {
          "nameForms" : [
            {
              "lang" : "ja-Latn",
              "fullText" : "Edo Sumida",
              "parts" : [
                {
                  "type" : "http://gedcomx.org/Given",
                  "value" : "Sumida"
                },
                {
                  "type" : "http://gedcomx.org/Surname",
                  "value" : "Edo"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Authentication Examples

Source: https://www.familysearch.org/en/developers/docs/api/examples

Examples related to managing access tokens and initiating the authorization process.

```APIDOC
## Delete Access Token

### Description
How to invalidate an access token.

### Method
DELETE

### Endpoint
/access_token/{accessToken}

```

```APIDOC
## Initiate Authorization (Invalid Parameter)

### Description
Example illustrating the result of invalid parameters when initiating the process for obtaining an OAuth 2 authorization code.

### Method
GET

### Endpoint
/oauth2/authorize

```

```APIDOC
## Obtain Access Token (Bad Parameters)

### Description
Example of invalid parameters when exchanging the authorization code for an access token.

### Method
POST

### Endpoint
/oauth2/token

```

```APIDOC
## Obtain Access Token with Username and Password

### Description
How to exchange a user's username and password for an access token.

### Method
POST

### Endpoint
/oauth2/token

```

```APIDOC
## Obtain Access Token without Authenticating

### Description
How to obtain an access token without authenticating.

### Method
POST

### Endpoint
/oauth2/token

```

--------------------------------

### Get Place Types (XML)

Source: https://www.familysearch.org/en/developers/docs/api/places/Read_Place_Types_usecase

This example demonstrates how to fetch the list of place types using a GET request with an Accept header for XML.

```APIDOC
## GET /platform/places/types

### Description
Retrieves a list of all available place types in RDF/XML format.

### Method
GET

### Endpoint
/platform/places/types

### Headers
- Accept: application/rdf+xml
- Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

### Response
#### Success Response (200 OK)
- Content-type: application/rdf+xml
- Body: An XML document containing a list of place types, each with an ID, labels, and descriptions.

### Response Example
```xml
<?xml version='1.0' encoding='UTF-8'?>
<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" xmlns:dc="http://purl.org/dc/terms/" xmlns:xml="http://www.w3.org/XML/1998/namespace">
  <Description about="https://api.familysearch.org/platform/places/types">
    <type resource="http://www.w3.org/1999/02/22-rdf-syntax-ns#Seq"/>
    <dc:title>Place Type List Title</dc:title>
    <dc:description>Place Type List Description</dc:description>
    <dc:hasPart parseType="Collection">
      <Description about="https://api.familysearch.org/platform/places/types/1"/>
      <Description about="https://api.familysearch.org/platform/places/types/2"/>
    </dc:hasPart>
    <li>
      <Description about="https://api.familysearch.org/platform/places/types/1">
        <dc:identifier>1</dc:identifier>
        <rdfs:label xml:lang="en">Place Type 1 Title</rdfs:label>
        <rdfs:comment xml:lang="en">Place Type 1 Description</rdfs:comment>
      </Description>
    </li>
    <li>
      <Description about="https://api.familysearch.org/platform/places/types/2">
        <dc:identifier>2</dc:identifier>
        <rdfs:label xml:lang="en">Place Type 2 Title</rdfs:label>
        <rdfs:comment xml:lang="en">Place Type 2 Description</rdfs:comment>
      </Description>
    </li>
  </Description>
</RDF>
```
```

--------------------------------

### Create Source Folder (XML)

Source: https://www.familysearch.org/en/developers/docs/api/sources/Create_Source_Folder_usecase

This example demonstrates how to create a source folder using an XML request.

```APIDOC
## POST /platform/sources/collections

### Description
Creates a new source folder using XML format.

### Method
POST

### Endpoint
/platform/sources/collections

### Request Body
- **XML Document** - Required - The XML document containing the source folder details.
  - **collection** (element) - Represents a collection to be created.
    - **id** (attribute) - Required - The unique identifier for the collection.
    - **title** (element) - Required - The display name of the collection.
    - **attribution** (element) - Optional - Information about the attribution of the collection.
      - **contributor** (element) - Required - Information about the contributor.
        - **resource** (attribute) - Required - The URL of the contributor's agent resource.
      - **modified** (element) - Required - The timestamp when the collection was last modified.
      - **changeMessage** (element) - Required - A message describing the changes made.

### Request Example
```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<fs:familysearch xmlns:fs="http://familysearch.org/v1/" xmlns="http://gedcomx.org/v1/" xmlns:atom="http://www.w3.org/2005/Atom">
    <collection id="src-MMMM-MMM">
        <title>Collection Name</title>
        <attribution>
            <contributor resource="https://familysearch.org/platform/users/agents/123"/>
            <modified>2018-12-01T08:11:07.759-07:00</modified>
            <changeMessage>This is the change message</changeMessage>
        </attribution>
    </collection>
</fs:familysearch>
```

### Response
#### Success Response (201 Created)
- **Content-type** (header) - Specifies the content type of the response.
- **X-entity-id** (header) - The ID of the created entity.
- **Location** (header) - The URL of the created entity.

#### Response Example
```
HTTP/1.1 201 Created
Content-type: application/x-fs-v1+xml
X-entity-id: src-MMMM-MMM
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-cache, no-store, no-transform, must-revalidate, max-age=0
Location: https://api.familysearch.org/platform/sources/collections/src-MMMM-MMM
Transfer-encoding: chunked
```
```

--------------------------------

### Get Name Script

Source: https://www.familysearch.org/en/developers/docs/api/names/Read_name_script_usecase

This example request illustrates how to get a script for a name. A map containing one entry for the script type and the code for that script will be returned.

```APIDOC
## GET /platform/names/script

### Description
Retrieves the script for a given name.

### Method
GET

### Endpoint
/platform/names/script

#### Query Parameters
- **text** (string) - Required - The name for which to retrieve the script.

#### Headers
- **Accept** (string) - Optional - `application/json`
- **Authorization** (string) - Required - `Bearer YOUR_ACCESS_TOKEN_HERE`
- **Accept-Language** (string) - Optional - `en`

### Response
#### Success Response (200)
- **script_type** (string) - The type of script (e.g., 'Katakana').
- **script_code** (string) - The code for the script (e.g., 'Kana').

### Response Example
```json
{
  "Katakana": "Kana"
}
```
```

--------------------------------

### Read User Source Descriptions (JSON)

Source: https://www.familysearch.org/en/developers/docs/api/sources/Read_User_Source_Descriptions_usecase

This example demonstrates how to fetch source descriptions in JSON format for a given user. The `start` and `count` parameters control pagination.

```APIDOC
## GET /platform/sources/{sourceId}/collections/descriptions

### Description
Retrieves a paged list of source descriptions provided by a specific user.

### Method
GET

### Endpoint
/platform/sources/{sourceId}/collections/descriptions

### Parameters
#### Query Parameters
- **start** (integer) - Optional - The starting index for the results.
- **count** (integer) - Optional - The number of results to return per page.

### Request Example
```http
GET /platform/sources/CCCC-CCC/collections/descriptions?start=2&count=1
Accept: application/x-fs-v1+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
```

### Response
#### Success Response (200)
- **links** (object) - Contains links for pagination (next, last, prev, self, first).
- **sourceDescriptions** (array) - An array of source description objects.
  - **id** (string) - The unique identifier for the source description.
  - **about** (string) - A URI referencing the source description.
  - **attribution** (object) - Information about the contributor and modification.
  - **links** (object) - Links related to the source description.
  - **citations** (array) - An array of citation strings.
  - **titles** (array) - An array of title objects.
  - **notes** (array) - An array of note objects.

#### Response Example
```json
{
  "links" : {
    "next" : {
      "href" : "https://api.familysearch.org/platform/sources/CCCC-CCC/collections/descriptions?flag=fsh&count=1&start=3"
    },
    "last" : {
      "href" : "https://api.familysearch.org/platform/sources/CCCC-CCC/collections/descriptions?flag=fsh&count=1&start=4"
    },
    "prev" : {
      "href" : "https://api.familysearch.org/platform/sources/CCCC-CCC/collections/descriptions?flag=fsh&count=1&start=1"
    },
    "self" : {
      "href" : "https://api.familysearch.org/platform/sources/CCCC-CCC/collections/descriptions?flag=fsh&count=1&start=2"
    },
    "first" : {
      "href" : "https://api.familysearch.org/platform/sources/CCCC-CCC/collections/descriptions?flag=fsh&count=1&start=0"
    }
  },
  "sourceDescriptions" : [ {
    "id" : "MMMM-CCC",
    "about" : "https://familysearch.org/pal:/MM9.1.1/M9PJ-2JJ",
    "attribution" : {
      "contributor" : {
        "resource" : "https://api.familysearch.org/platform/users/agents/123",
        "resourceId" : "123"
      },
      "modified" : 1543677067759,
      "changeMessage" : "This is the change message"
    },
    "links" : {
      "description" : {
        "href" : "https://api.familysearch.org/platform/sources/descriptions/MMMM-CCC?flag=fsh"
      },
      "source-references-query" : {
        "href" : "https://api.familysearch.org/tree/source-references?flag=fsh"
      }
    },
    "citations" : [ {
      "value" : "\"United States Census, 1900.\" database and digital images, FamilySearch (https://familysearch.org/: accessed 17 Mar 2012), Ethel Hollivet, 1900; citing United States Census Office, Washington, D.C., 1900 Population Census Schedules, Los Angeles, California, population schedule, Los Angeles Ward 6, Enumeration District 58, p. 20B, dwelling 470, family 501, FHL microfilm 1,240,090; citing NARA microfilm publication T623, roll 90."
    } ],
    "titles" : [ {
      "value" : "1900 US Census, Ethel Hollivet"
    } ],
    "notes" : [ {
      "text" : "Ethel Hollivet (line 75) with husband Albert Hollivet (line 74); also in the dwelling: step-father Joseph E Watkins (line 72), mother Lina Watkins (line 73), and grandmother -- Lina's mother -- Mary Sasnett (line 76).  Albert's mother and brother also appear on this page -- Emma Hollivet (line 68), and Eddie (line 69)."
    } ]
  } ]
}
```
```

--------------------------------

### Create Source Folder (JSON)

Source: https://www.familysearch.org/en/developers/docs/api/sources/Create_Source_Folder_usecase

This example demonstrates how to create a source folder using a JSON request.

```APIDOC
## POST /platform/sources/collections

### Description
Creates a new source folder with the provided details.

### Method
POST

### Endpoint
/platform/sources/collections

### Request Body
- **collections** (array) - Required - An array containing collection objects to be created.
  - **id** (string) - Required - The unique identifier for the collection.
  - **title** (string) - Required - The display name of the collection.
  - **attribution** (object) - Optional - Information about the attribution of the collection.
    - **contributor** (object) - Required - Information about the contributor.
      - **resource** (string) - Required - The URL of the contributor's agent resource.
    - **modified** (integer) - Required - The timestamp when the collection was last modified.
    - **changeMessage** (string) - Required - A message describing the changes made.

### Request Example
```json
{
  "collections" : [ {
    "id" : "src-MMMM-MMM",
    "title" : "Collection Name",
    "attribution" : {
      "contributor" : {
        "resource" : "https://familysearch.org/platform/users/agents/123"
      },
      "modified" : 1543677067759,
      "changeMessage" : "This is the change message"
    }
  } ]
}
```

### Response
#### Success Response (201 Created)
- **X-entity-id** (string) - The ID of the created entity.
- **Location** (string) - The URL of the created entity.

#### Response Example
```
HTTP/1.1 201 Created
Content-type: application/x-fs-v1+json
X-entity-id: src-MMMM-MMM
X-processing-time: 3
Vary: Accept,Accept-Language,Accept-Encoding,Expect
Date: Sun, 03 Apr 1836 10:00:00 GMT-5
Cache-control: no-cache, no-store, no-transform, must-revalidate, max-age=0
Location: https://api.familysearch.org/platform/sources/collections/src-MMMM-MMM
Transfer-encoding: chunked
```
```

--------------------------------

### Read a Page of Sources in a Folder (XML)

Source: https://www.familysearch.org/en/developers/docs/api/sources/Read_a_Page_of_the_Sources_in_a_Folder_usecase

This example demonstrates how to make a GET request to retrieve a page of source descriptions from a folder in XML format. It includes query parameters for pagination and necessary headers for authentication and content negotiation.

```APIDOC
## GET /platform/sources/collections/{collection-id}/descriptions

### Description
Retrieves a paginated list of source descriptions within a specified collection (folder).

### Method
GET

### Endpoint
/platform/sources/collections/sf-MMMM-123/descriptions

### Query Parameters
- **start** (integer) - Optional - The starting index for the results.
- **count** (integer) - Optional - The number of results to return per page.

### Headers
- **Accept**: application/x-fs-v1+xml
- **Authorization**: Bearer YOUR_ACCESS_TOKEN_HERE

### Request Example
```
GET /platform/sources/collections/sf-MMMM-123/descriptions?start=2&count=1
Accept: application/x-fs-v1+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
```
```

--------------------------------

### Create Source Description (XML Request)

Source: https://www.familysearch.org/en/developers/docs/api/sources/Create_Source_Description_usecase

This XML request demonstrates how to create a source description. Ensure the Authorization header is correctly set.

```http
POST /platform/sources/descriptions
Content-Type: application/x-gedcomx-v1+xml
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
                
                  <?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">
    <sourceDescription about="https://familysearch.org/pal:/MM9.1.1/M9PJ-2JJ">
        <citation>
            <value>"United States Census, 1900." database and digital images, FamilySearch (https://familysearch.org/: accessed 17 Mar 2012), Ethel Hollivet, 1900; citing United States Census Office, Washington, D.C., 1900 Population Census Schedules, Los Angeles, California, population schedule, Los Angeles Ward 6, Enumeration District 58, p. 20B, dwelling 470, family 501, FHL microfilm 1,240,090; citing NARA microfilm publication T623, roll 90.</value>
        </citation>
        <title>1900 US Census, Ethel Hollivet</title>
        <note>
            <text>Ethel Hollivet (line 75) with husband Albert Hollivet (line 74); also in the dwelling: step-father Joseph E Watkins (line 72), mother Lina Watkins (line 73), and grandmother -- Lina's mother -- Mary Sasnett (line 76).  Albert's mother and brother also appear on this page -- Emma Hollivet (line 68), and Eddie (line 69).</text>
        </note>
        <attribution>
            <contributor resource="https://api.familysearch.org/platform/users/agents/123" resourceId="123"/>
            <modified>2018-12-01T08:11:07.759-07:00</modified>
            <changeMessage>This is the change message</changeMessage>
        </attribution>
    </sourceDescription>
</gedcomx>
                
              
```

--------------------------------

### Read User Source Folders (XML)

Source: https://www.familysearch.org/en/developers/docs/api/sources/Read_User_Source_Folders_usecase

This example demonstrates how to retrieve a user's source folders in XML format.

```APIDOC
## GET /platform/sources/{userId}/collections

### Description
Retrieves a list of source folders associated with a specific user.

### Method
GET

### Endpoint
/platform/sources/{userId}/collections

### Headers
- Accept: application/x-fs-v1+xml
- Content-Type: application/x-fs-v1+xml
- Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

### Response
#### Success Response (200)
- **link** (object) - Contains links to related resources.
  - **rel** (string) - Relationship type (e.g., 'collection').
  - **href** (string) - URL for the linked resource.
- **sourceDescription** (object) - Details of the source description.
  - **title** (string) - Title of the source description.
  - **attribution** (object) - Information about the contributor and modification.
    - **contributor** (object) - Details of the contributor.
      - **resource** (string) - URL of the contributor.
    - **modified** (string) - Timestamp of modification.
    - **changeMessage** (string) - Message associated with the change.
- **collection** (object) - Details of the collection.
  - **id** (string) - Unique identifier for the collection.
  - **link** (array) - List of links related to the collection.
    - **rel** (string) - Relationship type (e.g., 'self', 'source-descriptions').
    - **href** (string) - URL for the linked resource.
  - **title** (string) - Title of the collection.
  - **attribution** (object) - Information about the contributor and modification.
    - **contributor** (object) - Details of the contributor.
      - **resource** (string) - URL of the contributor.
    - **modified** (string) - Timestamp of modification.
    - **changeMessage** (string) - Message associated with the change.

### Response Example
```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<fs:familysearch xmlns:fs="http://familysearch.org/v1/" xmlns="http://gedcomx.org/v1/" xmlns:atom="http://www.w3.org/2005/Atom">
    <link rel="collection" href="https://api.familysearch.org/platform/sources/collections?flag=fsh"/>
    <sourceDescription>
        <title>Collection Title</title>
        <attribution>
            <contributor resource="https://familysearch.org/platform/users/agents/123"/>
            <modified>2018-12-01T08:11:07.759-07:00</modified>
            <changeMessage>This is the change message</changeMessage>
        </attribution>
    </sourceDescription>
    <collection id="MMMM-MMM">
        <link rel="self" href="https://api.familysearch.org/platform/sources/collections/MMMM-MMM?flag=fsh"/>
        <link rel="source-descriptions" href="https://api.familysearch.org/platform/sources/collections/MMMM-MMM/descriptions?flag=fsh"/>
        <title>Collection Title</title>
        <attribution>
            <contributor resource="https://familysearch.org/platform/users/agents/123"/>
            <modified>2018-12-01T08:11:07.759-07:00</modified>
            <changeMessage>This is the change message</changeMessage>
        </attribution>
    </collection>
</fs:familysearch>
```
```

--------------------------------

### GET Request for Sources (JSON)

Source: https://www.familysearch.org/en/developers/docs/api/sources/Read_a_Page_of_the_Sources_in_a_Folder_usecase

Use this GET request to retrieve a page of source descriptions in JSON format. Specify the collection ID, start index, and count for pagination. Ensure the Accept header is set to application/x-fs-v1+json.

```http
GET /platform/sources/collections/sf-MMMM-123/descriptions?start=2&count=1
Accept: application/x-fs-v1+json
Authorization: Bearer YOUR_ACCESS_TOKEN_HERE
```

--------------------------------

### Get Place Type Groups (XML)

Source: https://www.familysearch.org/en/developers/docs/api/places/Read_Place_Type_Groups_usecase

This example demonstrates how to request the list of place type groups in XML format.

```APIDOC
## GET /platform/places/type-groups

### Description
Retrieves a list of place type groups in RDF/XML format.

### Method
GET

### Endpoint
/platform/places/type-groups

### Headers
- Accept: application/rdf+xml
- Authorization: Bearer YOUR_ACCESS_TOKEN_HERE

### Response
#### Success Response (200)
- The response will be in RDF/XML format, containing details about place type groups.

### Response Example
```xml
<?xml version='1.0' encoding='UTF-8'?>
<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" xmlns:dc="http://purl.org/dc/terms/" xmlns:xml="http://www.w3.org/XML/1998/namespace">
  <Description about="https://api.familysearch.org/platform/places/type-groups">
    <type resource="http://www.w3.org/1999/02/22-rdf-syntax-ns#Seq"/>
    <dc:title>List Title</dc:title>
    <dc:description>List Description</dc:description>
    <dc:hasPart parseType="Collection">
      <Description about="https://api.familysearch.org/platform/places/type-groups/1"/>
      <Description about="https://api.familysearch.org/platform/places/type-groups/2"/>
    </dc:hasPart>
    <li>
      <Description about="https://api.familysearch.org/platform/places/type-groups/1">
        <dc:identifier>1</dc:identifier>
        <rdfs:label xml:lang="en">Place Type Group 1 Title</rdfs:label>
        <rdfs:comment xml:lang="en">Place Type Group 1 Description</rdfs:comment>
      </Description>
    </li>
    <li>
      <Description about="https://api.familysearch.org/platform/places/type-groups/2">
        <dc:identifier>2</dc:identifier>
        <rdfs:label xml:lang="en">Place Type Group 2 Title</rdfs:label>
        <rdfs:comment xml:lang="en">Place Type Group 2 Description</rdfs:comment>
      </Description>
    </li>
  </Description>
</RDF>
```
```
Tokens:
Raw