Skip to main content
GET
/
api
/
v1
/
users
/
status
Get user status and commission summary
curl --request GET \
  --url https://app.mlm-platform.com/api/v1/users/status \
  --header 'x-tenant-api-key: <api-key>'
{
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "jsmith@example.com",
  "membership_tier": "ORDINARY",
  "is_active": true,
  "can_recruit": true,
  "commission_balance": {
    "pending": 123,
    "cleared": 123,
    "paid": 123,
    "total": 123
  },
  "currency": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.mlm-platform.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-tenant-api-key
string
header
required

Tenant API key for authentication. Keys are scoped to specific environments (LIVE or SANDBOX). Obtain keys from the admin dashboard.

Query Parameters

​
user_id
string<uuid>
required

The user ID to get status for

Response

User status retrieved

​
user_id
string<uuid>
​
email
string<email>
​
membership_tier
enum<string>

Member's tier in the hierarchy

Available options:
ORDINARY,
SENIOR,
MANAGER,
DIRECTOR
​
is_active
boolean
​
can_recruit
boolean
​
commission_balance
object
​
currency
string