Get users by list ids

Gets the users by id list.

get

Query parameters

idsstring[]Optional

The ids to get the users.The maximum number of ids is 100.

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

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/users/by-list-id HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "brandId": "xZrwkBM58VN",
        "parentUser": {
          "id": "sApKpllz4sAplsmzha",
          "code": "PZBAAE",
          "avatar": "https://www.jframework.io/admin.jpg",
          "packageId": "yDpX0wAbpGRqjv3l",
          "packageCode": "STANDARD",
          "emailAddress": "[email protected]",
          "phoneNumber": null,
          "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": "f91c3d33-b0ea-4bcd-a7e0-6ddeb4b58055",
            "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,
          "tier": 0,
          "zOrder": 1,
          "features": [
            {
              "title": "Feature Title",
              "quantity": 10,
              "value": 10,
              "isUnlimited": false,
              "id": "sApKpllz4sAplsmzha",
              "parentBrandId": "Brand_ID",
              "eventId": "Event_ID",
              "type": "Function",
              "code": "Code",
              "name": "Feature Name",
              "unit": "Unit",
              "defaultValue": null,
              "helpURL": null,
              "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": "en-US",
        "countryCode": "US",
        "timeZoneId": "QlzwLjGaKvAvbD5x",
        "expiryDate": "2025-10-12T08:18:49.786229Z",
        "themeStyle": "light",
        "enableSignInDetection": true,
        "isUserIntegration": false,
        "createdDate": "2025-09-12T08:18:49.786229Z"
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 10
  },
  "errors": []
}