cURL
curl --request GET \ --url https://app.mlm-platform.com/api/v1/members/{userId}/relationship/{targetUserId} \ --header 'x-tenant-api-key: <api-key>'
{ "connected": true, "relationship": "upline", "distance": 123, "path": [ { "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "email": "jsmith@example.com", "name": "<string>", "givenName": "<string>", "surname": "<string>", "membershipTier": "ORDINARY", "isActive": true, "depth": 123, "directReferrals": 123, "totalDownline": 123, "joinedAt": "2023-11-07T05:31:56Z", "children": "<array>" } ] }
Returns the relationship and path between two members.
Tenant API key for authentication
Relationship path
upline
downline
sibling
none
Show child attributes