Get Active Devices API

Retrieve all active devices across the entire platform with detailed status and connection information

Devices

Get Active Devices API

Access the complete list of all active devices across your platform. Monitor device registrations, login status, and manage device blocks globally.

Platform-Wide

All active devices.

Security Status

Block and active flags.

Push Tokens

FCM notification tokens.


Endpoint Overview

QUERY/graphql

Retrieve all active devices across the platform with detailed information including user association, device model, and notification tokens.

Authentication:Bearer Token
Required scopes:admin

GraphQL Query

query getActiveDevices {
  getActiveDevices {
    id
    userId
    os
    deviceId
    loginDate
    logoutDate
    appVersion
    deviceModel
    deviceName
    fcmToken
    isActive
    isBlocked
  }
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "query": "query getActiveDevices { getActiveDevices { id userId os deviceId deviceModel deviceName isActive isBlocked loginDate } }"
  }'

Response

200Active Devices Retrieved Successfully
{
  "data": {
    "getActiveDevices": [
      {
        "id": "dev_001",
        "userId": "12345",
        "os": "iOS",
        "deviceId": "A1B2C3D4-E5F6-7890",
        "loginDate": "2024-01-15T10:30:00Z",
        "logoutDate": null,
        "appVersion": "3.2.1",
        "deviceModel": "iPhone 15 Pro",
        "deviceName": "John's iPhone",
        "fcmToken": "dGhpcyBpcyBhIHNhbXBsZSB0b2tlbg==",
        "isActive": true,
        "isBlocked": false
      },
      {
        "id": "dev_002",
        "userId": "12346",
        "os": "Android",
        "deviceId": "android_xyz789",
        "loginDate": "2024-01-15T08:00:00Z",
        "logoutDate": null,
        "appVersion": "3.2.0",
        "deviceModel": "Samsung Galaxy S24",
        "deviceName": "Work Phone",
        "fcmToken": "YW5vdGhlciBzYW1wbGUgdG9rZW4=",
        "isActive": true,
        "isBlocked": false
      },
      {
        "id": "dev_003",
        "userId": "12347",
        "os": "macOS",
        "deviceId": "mac_abc123",
        "loginDate": "2024-01-14T12:00:00Z",
        "logoutDate": "2024-01-14T18:00:00Z",
        "appVersion": "3.1.5",
        "deviceModel": "MacBook Pro 16",
        "deviceName": "Office Mac",
        "fcmToken": null,
        "isActive": true,
        "isBlocked": true
      }
    ]
  }
}
401Unauthorized
{
  "errors": [
    {
      "message": "Admin authentication required",
      "path": ["getActiveDevices"],
      "extensions": {
        "code": "UNAUTHORIZED"
      }
    }
  ],
  "data": null
}

Response Fields

idID!

Unique identifier for the device record.

userIdID!

ID of the user who owns this device.

deviceIdString!

Unique hardware/software identifier for the device.

deviceModelString

Device hardware model (e.g., iPhone 15 Pro, Galaxy S24).

deviceNameString

User-assigned name for the device.

osString!

Operating system (iOS, Android, macOS, Windows, Linux).

appVersionString!

Version of the VPN app installed.

loginDateDateTime!

When the device was first registered/logged in.

logoutDateDateTime

When the device was last logged out (null if still logged in).

isActiveBoolean!

Whether the device registration is active.

isBlockedBoolean!

Whether the device has been blocked by an admin.

fcmTokenString

Firebase Cloud Messaging token for push notifications.


Device Status Matrix

Active & Connected

Device is logged in and can connect.

Active & Blocked

Device is blocked from connecting.

Logged Out

Device has been logged out.

Push Enabled

Device can receive notifications.


Use Cases

Admin Dashboard

Display all registered devices.

Security Audit

Review device registrations.

Push Campaigns

Collect FCM tokens for notifications.

App Analytics

Track version adoption.



Admin Only

This endpoint returns data for all users and is restricted to admin accounts. Use with caution in production environments due to potentially large result sets.

Manage Device Access

Block or deactivate devices that pose security risks.

Deactivate Device