Skip to main content
GET
/
api
/
v1
/
members
/
{userId}
/
genealogy
Get member's downline tree
curl --request GET \
  --url https://app.mlm-platform.com/api/v1/members/{userId}/genealogy \
  --header 'x-tenant-api-key: <api-key>'
{
  "tree": {
    "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>"
  },
  "meta": {
    "maxDepth": 123,
    "includeInactive": true,
    "totalNodes": 123
  }
}

Authorizations

x-tenant-api-key
string
header
required

Tenant API key for authentication

Path Parameters

userId
string<uuid>
required

Query Parameters

maxDepth
integer
default:5
Required range: 1 <= x <= 10
includeInactive
boolean
default:false

Response

Downline tree

tree
object
required
meta
object
required