Get devices

Get devices

get

Query parameters

UserIdstringOptional

Filter by id of the user.

Typestring · enumOptional

Device type enum. See more: https://help.jframework.io/services/identity/device/device-type

Possible values:

CodestringOptional

The code to filter.

NamestringOptional

The device name to filter.

IsMobileAppbooleanOptional

Filter with is mobile app.

TestModebooleanOptional

The test mode to filter.

Statusstring · enumOptional

Represents the status of a device within the system.

Possible values:

KeywordsstringOptional

The keywords to filter.

CountryCodestringOptional

The CountryCode to filter.

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

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/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": {
    "items": [
      {
        "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.2936073Z"
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 20
  },
  "errors": []
}