Get devices from a user

Get devices from a user.

get

Path parameters

userIdstringRequired

The id of the user

Query parameters

isMobileAppbooleanOptional

(Optional) A flag to filter devices by platform. If true, only mobile app devices are returned. If false, only non-mobile devices are returned. If null, all devices are returned.

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

404

The user was not found in the system.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/users/{userId}/devices

HTTPcURLJavaScriptPython

GET /api/v1/users/{userId}/devices 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",
      "countryCode": "US",
      "lastAccessAt": "2026-01-26T01:03:23.943344Z",
      "type": "Mobile",
      "code": "XYZ123",
      "isMobileApp": true,
      "tags": "android, smartphone",
      "status": "Active",
      "isDefault": true,
      "testMode": false,
      "name": "John's Phone",
      "phoneNumber": "[phone]",
      "osDevice": "Android",
      "appVersionNumber": "1.0.5",
      "iccid": "89148000000000000001",
      "imsi": "310260000000000",
      "imei": "356938035643809",
      "simCardInfo": "Verizon SIM",
      "avatarURL": "https://example.com/avatar.jpg",
      "modifiedDate": "2026-01-26T01:03:23.943344Z",
      "token": "YOUR_TOKEN_REGISTER",
      "session": "YOUR_SESSION_USER_WITH_DEVICE",
      "userDeviceStatus": "Offline"
    }
  ],
  "errors": []
}