Get users

Get users in your system.

get

A subset of users can be returned that match a supported filter expression or search criteria.

Query parameters

IdsstringOptional

The list id of the user to filter.

RoleIdstringOptional

The role id of the user.

CodestringOptional

The code of the user.

UsernamestringOptional

The username of the user.

UserTypestringOptional

The type of the user.

IsEmailAddressVerifiedbooleanOptional

Filter with is email address verified.

IsUserVerifiedbooleanOptional

Filter with is user verified.

TestModebooleanOptional

The email address of the user.

Statusstring · enumOptional

This enum is used to map the User Status from the database.

Possible values:

IsSystembooleanOptional

Filter with is system user.

FirstNamestringOptional

Th first name of the user.

LastNamestringOptional

The last name of the user.

NickNamestringOptional

The nickname of the user.

AvatarstringOptional

The avatar of the user.

EmailAddressstringOptional

The email address of the user.

PhoneNumberstringOptional

The phone number

KeywordsstringOptional

The keywords to search.

PackageIdstringOptional

The package id of the user.

CreationTypestring · enumOptional

Specifies the origin or method by which a user was created in the system.

Possible values:

LanguageCodestringOptional

The language code of the user.

TimeZoneIdstringOptional

The time zone id of the user.

TrackingLevelinteger · int32Optional

The tracking level of the user.

ReferralCodestringOptional

The referral code of the user.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

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

/api/v1/users

HTTPcURLJavaScriptPython

GET /api/v1/users 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": "[e-mail]",
          "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": "[e-mail]",
        "phoneNumber": "+01234567890",
        "website": "https://www.johndoe.com",
        "bio": null,
        "type": "EndUser",
        "isEmailAddressVerified": false,
        "isUserVerified": false,
        "riskMark": 50,
        "roles": [
          {
            "id": "sApKpllz4sAplsmzha",
            "parentBrandId": "xZrwkBM58VN",
            "guid": "1ea27bb9-0b2d-44cb-b99e-dc2718e52388",
            "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": [
            {
              "type": "Function",
              "title": "Feature Title",
              "value": 10,
              "isUnlimited": false,
              "resetPolicy": 0,
              "customIntervalDays": null,
              "id": "sApKpllz4sAplsmzha",
              "parentBrandId": "Brand_ID",
              "eventId": "Event_ID",
              "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,
          "status": "Inactive"
        },
        "packageId": "yDpX0wAbpGRqjv3l",
        "languageCode": "en-US",
        "countryCode": "US",
        "timeZoneId": "QlzwLjGaKvAvbD5x",
        "expiryDate": "2026-02-25T01:03:23.929566Z",
        "themeStyle": "light",
        "enableSignInDetection": true,
        "isUserIntegration": false,
        "createdDate": "2026-01-26T01:03:23.929567Z"
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 10
  },
  "errors": []
}

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

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

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

/api/v1/users/by-list-id

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": "[e-mail]",
          "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": "[e-mail]",
        "phoneNumber": "+01234567890",
        "website": "https://www.johndoe.com",
        "bio": null,
        "type": "EndUser",
        "isEmailAddressVerified": false,
        "isUserVerified": false,
        "riskMark": 50,
        "roles": [
          {
            "id": "sApKpllz4sAplsmzha",
            "parentBrandId": "xZrwkBM58VN",
            "guid": "c6d306c7-5090-4dea-9c72-09e91bb14dc2",
            "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": [
            {
              "type": "Function",
              "title": "Feature Title",
              "value": 10,
              "isUnlimited": false,
              "resetPolicy": 0,
              "customIntervalDays": null,
              "id": "sApKpllz4sAplsmzha",
              "parentBrandId": "Brand_ID",
              "eventId": "Event_ID",
              "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,
          "status": "Inactive"
        },
        "packageId": "yDpX0wAbpGRqjv3l",
        "languageCode": "en-US",
        "countryCode": "US",
        "timeZoneId": "QlzwLjGaKvAvbD5x",
        "expiryDate": "2026-02-25T01:03:23.930087Z",
        "themeStyle": "light",
        "enableSignInDetection": true,
        "isUserIntegration": false,
        "createdDate": "2026-01-26T01:03:23.930088Z"
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 10
  },
  "errors": []
}