FAfamilysearch
Source Box

Read User Defined Collection Descriptions

Read the source descriptions in a user-defined collection.

get/sources/collections/{udcid}/descriptions

Request

  • Base URL
    https://apibeta.familysearch.org/platform
  • URL
    https://apibeta.familysearch.org/platform/sources/collections/{udcid}/descriptions
  • Auth
    HTTP bearer

Path parameters

udcidstring required

The id of the user-defined collection. To find source folder IDs, see <a href="/reference/readusersourcefolders" target="_blank">Read User Source Folders</a>, or <a href="/reference/createsourcefolder" target="_blank">Create Source Folder</a> to create a new source folder.

Query parameters

startinteger

The index (zero-based) of the first source description to be returned from a user-defined collection.

countinteger

The maximum number of source descriptions being requested.

Headers

Accept'application/x-fs-v1+json' | 'application/x-gedcomx-v1+json' | 'application/json' | 'application/x-fs-v1+xml' | 'application/x-gedcomx-v1+xml' | 'application/xml' required

Specifies the media type(s) that the client is willing to accept in the response.

Response

The read was successful. See <a href="https://developers.familysearch.org/main/docs/json-schema#sourcedescription" target="_blank">SourceDescription Schema (JSON)</a>

Changes

No recorded changes to this operation across all 1 revision of this API.