FAfamilysearch
Relationships: Couple

Read Preferred Spouse Relationship

Read the preferred spouse relationship for the given user and tree person. The preferred spouse relationship affects only the user that creates it.

get/tree/users/{uid}/preferred-spouse-relationships/{pid}

Request

  • Base URL
    https://apibeta.familysearch.org/platform
  • URL
    https://apibeta.familysearch.org/platform/tree/users/{uid}/preferred-spouse-relationships/{pid}
  • Auth
    HTTP bearer

Path parameters

uidstring required

The id of the authenticated user. To find user IDs, see <a href="/reference/readcurrentuser" target="_blank">Read Current User</a>.

pidstring required

The id of the tree person. Can be a person from the main FamilySearch tree or from a user tree. To find an example person ID, see <a href="/reference/searchtreepersons" target="_blank">Search Tree Persons</a>.

Response

No preference specified.

Changes

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