Get a device by code

Gets the device by the given code.

get

Path parameters

codestringRequired

The code of the device.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Responses

200

The request was successful.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/devices/by-code/{code}

HTTPcURLJavaScriptPython

GET /api/v1/devices/by-code/{code} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "type": "Web",
    "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": null,
    "modifiedDate": "2025-09-19T04:20:20.3000073Z"
  },
  "errors": []
}