List all relationships belonging to a guest

This API retrieves all the relationships of a guest. For example, spouse, friend, etc. This allows you to view a list of all the family members of the guest.

Response Details

NameTypeDescription
guest_relationshipsobjectObject containing the details of all the relationships of the guest.
relationshipobjectObject containing the details of the person related to the guest.
allow_sharing_accountsboolDenotes sharing of the guest account between the host and relative. True: Sharing is enabled between the host and the guest. False: Sharing is not enabled.

guest_relationships Object

NameTypeDescription
idguidUnique 32-character identifier of the guest.
namestringName of the guest.

relationship Object

NameTypeDescription
idguidUnique identifier of the relationship.
namestringDenotes the type of relationship. For example, a Friend, Spouse, or Child.

error Object

CodeMessage
502Invalid guest_id
Language
Credentials
Header
Click Try It! to start a request and see the response here!