Gets the referees of a user

Gets the referees of the user.

get

Path parameters

idstringRequired

The id of the user.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

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 Auth-Key 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.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "id": "sApKpllz4sAplsmzha",
      "brandId": "xZrwkBM58VN",
      "parentUser": {
        "id": "sApKpllz4sAplsmzha",
        "code": "PZBAAE",
        "avatar": "https://www.jframework.io/admin.jpg",
        "packageId": "yDpX0wAbpGRqjv3l",
        "packageCode": "STANDARD",
        "emailAddress": "[email protected]",
        "nickName": "Admin",
        "roles": [
          "Admin"
        ]
      },
      "code": "AABA24461C0E194BEF3E",
      "username": "john.doe",
      "firstName": "John",
      "lastName": "Doe",
      "nickName": null,
      "avatar": "https://www.johndoe.com/avatar.jpg",
      "emailAddress": "[email protected]",
      "phoneNumber": "+01234567890",
      "website": "https://www.johndoe.com",
      "bio": null,
      "type": "EndUser",
      "isEmailAddressVerified": false,
      "isUserVerified": false,
      "riskMark": 50,
      "roles": [
        {
          "id": "sApKpllz4sAplsmzha",
          "parentBrandId": "xZrwkBM58VN",
          "guid": "ff31732e-d015-45d3-8054-b0a71be6d22d",
          "code": "SUPER_ADMIN",
          "name": "Super Admin",
          "description": "Super Admin",
          "tags": "#Admin",
          "type": "BuiltIn",
          "permissions": [
            "USER.CREATE"
          ]
        }
      ],
      "referralCode": "AABAAE",
      "testMode": false,
      "tags": null,
      "status": "Active",
      "isSystem": false,
      "package": {
        "id": "sApKpllz4sAplsmzha",
        "code": "CODE",
        "name": "NAME",
        "imageURL": "IMAGE",
        "patternAvatarURL": "https://www.example.com/pattern.jpg",
        "styles": "{\"color\": \"red\"}",
        "description": "DESCRIPTION",
        "tags": "TAGS",
        "isFree": true,
        "zOrder": 1,
        "features": [
          {
            "title": "Feature Title",
            "unit": "Unit",
            "quantity": 10,
            "isUnlimited": false,
            "id": "sApKpllz4sAplsmzha",
            "parentBrandId": "Brand_ID",
            "eventId": "Event_ID",
            "type": "Function",
            "code": "Code",
            "name": "Feature Name",
            "image": "https://www.example.com/image.jpg",
            "styles": "{\"color\": \"red\"}",
            "description": "Feature Description",
            "tags": "#Tag1, #Tag2",
            "zOrder": 1,
            "status": "Active"
          }
        ],
        "prices": [
          {
            "id": "sApKpllz4sAplsmzha",
            "code": "Code",
            "name": "Name",
            "amount": 10,
            "currency": "USD",
            "description": "Description",
            "checkoutLink": "CheckoutLink",
            "tags": "Tags",
            "packageName": "PackageName",
            "packageId": "PackageId",
            "subscriptionName": "SubscriptionName",
            "subscriptionTypeId": "SubscriptionTypeId",
            "zOrder": 1
          }
        ],
        "isDefault": true
      },
      "packageId": "yDpX0wAbpGRqjv3l",
      "languageCode": "vi-VN",
      "timeZoneId": "QlzwLjGaKvAvbD5x",
      "expiryDate": "2025-07-23T06:56:00.8240225Z",
      "themeStyle": "light",
      "enableSignInDetection": true,
      "isUserIntegration": false,
      "createdDate": "2025-06-23T06:56:00.8240232Z"
    }
  ],
  "errors": []
}