v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

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.

get/v1/guests/{guest_id}/relationships

Path parameters

guest_idstring required

Mandatory Unique 32-character identifier of the guest.

Response

200

{"stackTrail":"paths:/v1/guests/{guest_id}/relationships:get:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown"}

Example response

{
  "guest_relationships": [
    {
      "id": 1,
      "guest": {
        "id": "8ce57cee-b2ee-4537-8f50-84ea37e3a8a7",
        "name": "nomem user"
      },
      "relationship": {
        "id": "bb91a992-0313-4a50-b4d9-71cc27cfc218",
        "name": "Friend"
      },
      "allow_sharing_accounts": true
    }
  ]
}