Gets the referees of a user

Gets the referees of the user.

get

Path parameters

idstringRequired

The id of the user.

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

AuthkeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required AuthKey header.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/users/{id}/referees HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "brandId": "xZrwkBM58VN",
      "parentUser": {
        "code": "PZBAAE",
        "avatar": "https://www.jframework.io/admin.jpg",
        "packageId": "yDpX0wAbpGRqjv3l",
        "packageCode": "STANDARD",
        "emailAddress": "[e-mail]",
        "nickName": "Admin",
        "roles": [
          "Admin"
        ],
        "id": "2rlzM7wMPlamsSa"
      },
      "code": "AABA24461C0E194BEF3E",
      "username": "john.doe",
      "firstName": "John",
      "lastName": "Doe",
      "nickName": null,
      "avatar": "https://www.johndoe.com/avatar.jpg",
      "emailAddress": "[e-mail]",
      "phoneNumber": "+01234567890",
      "website": "https://www.johndoe.com",
      "bio": null,
      "type": "EndUser",
      "isEmailAddressVerified": null,
      "isUserVerified": null,
      "riskMark": 50,
      "roles": [
        {
          "parentBrandId": "xZrwkBM58VN",
          "guid": "7f5706c5-da44-420b-928a-c0ca451ea065",
          "code": "SUPER_ADMIN",
          "name": "Super Admin",
          "description": "Super Admin",
          "tags": "#Admin",
          "type": "BuiltIn",
          "permissions": [
            "USER.CREATE"
          ],
          "id": "2rlzM7w"
        }
      ],
      "referralCode": "AABAAE",
      "testMode": false,
      "tags": null,
      "status": "Active",
      "isSystem": false,
      "package": "STANDARD",
      "packageId": "yDpX0wAbpGRqjv3l",
      "languageCode": "vi-VN",
      "timeZoneId": "QlzwLjGaKvAvbD5x",
      "expiryDate": "2025-06-07T13:15:32.126215Z",
      "themeStyle": "light",
      "enableSignInDetection": true,
      "isUserIntegration": false,
      "id": "2rlzM7wMrxdPLmsza",
      "createdDate": "2025-05-08T13:15:32.126216Z"
    }
  ],
  "errors": []
}