Get users from a device id

Get users from a device.

get

Path parameters

deviceIdstringRequired

The id of the device to get.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringOptional

Auth-Key is optional. Without it, the response may contain masked data.

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/{deviceId}/users HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "id": "Plamxinzg18snza",
      "code": "EXAMPLE",
      "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
      "packageId": "1Plamxinzg18snza",
      "packageCode": "PACKAGE",
      "emailAddress": "[email protected]",
      "phoneNumber": "[phone]",
      "nickName": "example",
      "roles": [
        "admin",
        "support"
      ]
    }
  ],
  "errors": []
}