FAfamilysearch
Relationships: Couple

Read Couple Relationship

Read a specific couple relationship.

get/tree/couple-relationships/{crid}

Request

  • Base URL
    https://apibeta.familysearch.org/platform
  • URL
    https://apibeta.familysearch.org/platform/tree/couple-relationships/{crid}
  • Auth
    HTTP bearer

Path parameters

cridstring required

The id of the couple relationship.

Query parameters

personsstring

'true' if a person is to be returned for each person in the relationship; false otherwise.

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#relationship" target="_blank">Relationship Schema (JSON)</a>

Changes

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