Skip to main content
GET
/
api
/
v1
/
members
/
{userId}
/
relationship
/
{targetUserId}
Get relationship between two members
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>"
    }
  ]
}

Authorizations

x-tenant-api-key
string
header
required

Tenant API key for authentication

Path Parameters

userId
string<uuid>
required
targetUserId
string<uuid>
required

Response

Relationship path

connected
boolean
relationship
enum<string>
Available options:
upline,
downline,
sibling,
none
distance
integer
path
object[]