Skip to main content
GET
/
api
/
v1
/
auth
/
user-by-external-id
Find MLM user by external ID
curl --request GET \
  --url https://app.mlm-platform.com/api/v1/auth/user-by-external-id \
  --header 'x-tenant-api-key: <api-key>'
{
  "user": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "membershipTier": "ORDINARY",
    "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isActive": true,
    "canRecruit": true,
    "isTestUser": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-tenant-api-key
string
header
required

Tenant API key for authentication

Query Parameters

externalId
string
required
provider
string
required

Response

User found

user
object