Devices

Devices are the hardware components that send location data to Pointeron — they are GPS trackers, smartphones, or IoT sensors assigned to your assets. On this page, we'll dive into the different device endpoints you can use to manage devices programmatically. We'll look at how to query, register, update, and delete devices.

The device model

The device model contains all the information about the tracking devices in your organization. Devices can be assigned to assets, have a unique hardware identifier, and report their connection status.

Properties

Name
id
Type
string
Description
Unique identifier for the device.
Name
asset_id
Type
string
Description
Unique identifier for the asset assigned to this device.
Name
name
Type
string
Description
The display name for the device.
Name
identifier
Type
string
Description
The unique hardware identifier (IMEI, serial number, etc.).
Name
protocol
Type
string
Description
The communication protocol used by the device (e.g., http, gt06, h02).
Name
is_online
Type
boolean
Description
Whether the device is currently fresh/reachable according to its device-specific presence rules. For GPS trackers, a live command connection requires an active TCP session.
Name
last_active_at
Type
timestamp
Description
Timestamp of when the device last sent data.
Name
created_at
Type
timestamp
Description
Timestamp of when the device was registered.

GET/v1/devices

List all devices

This endpoint allows you to retrieve a paginated list of all your devices. By default, a maximum of ten devices are shown per page.

Optional attributes

Name
limit
Type
integer
Description
Limit the number of devices returned.
Name
online
Type
boolean
Description
Only show devices considered fresh/reachable by their device-specific presence rules when set to true.
Name
protocol
Type
string
Description
Only show devices using the specified protocol.
Name
asset_id
Type
string
Description
Only show devices for the specified asset.

Request

GET

/v1/devices

curl -G https://api.pointeron.com/v1/devices \
  -H "Authorization: Bearer {token}" \
  -d limit=10

Response

{
  "has_more": false,
  "data": [
    {
      "id": "xgQQXg3hrtjh7AvZ",
      "asset_id": "WAz8eIbvDR60rouK",
      "name": "Fleet Tracker 01",
      "identifier": "GT06-ABC123",
      "protocol": "gt06",
      "is_online": true,
      "last_active_at": 705103200,
      "created_at": 692233200
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}

POST/v1/devices

Register a device

This endpoint allows you to register a new tracking device in your Pointeron organization. An identifier is required to register a device.

Required attributes

Name
identifier
Type
string
Description
The unique hardware identifier (IMEI, serial number, etc.).
Name
name
Type
string
Description
The display name for the device.

Optional attributes

Name
asset_id
Type
string
Description
Unique identifier for the asset to assign to this device.
Name
protocol
Type
string
Description
The communication protocol used by the device.

Request

POST

/v1/devices

curl https://api.pointeron.com/v1/devices \
  -H "Authorization: Bearer {token}" \
  -d 'identifier'="GT06-ABC123" \
  -d 'name'="Fleet Tracker 01"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "asset_id": null,
  "name": "Fleet Tracker 01",
  "identifier": "GT06-ABC123",
  "protocol": null,
  "is_online": false,
  "last_active_at": null,
  "created_at": 692233200
}

GET/v1/devices/:id

Retrieve a device

This endpoint allows you to retrieve a device by providing the device id. Refer to the list at the top of this page to see which properties are included with device objects.

Request

GET

/v1/devices/xgQQXg3hrtjh7AvZ

curl https://api.pointeron.com/v1/devices/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "asset_id": "WAz8eIbvDR60rouK",
  "name": "Fleet Tracker 01",
  "identifier": "GT06-ABC123",
  "protocol": "gt06",
  "is_online": true,
  "last_active_at": 705103200,
  "created_at": 692233200
}

PUT/v1/devices/:id

Update a device

This endpoint allows you to perform an update on a device. Examples of updates are changing the name, assigning it to a different asset, or updating the protocol.

Optional attributes

Name
name
Type
string
Description
The new display name for the device.
Name
asset_id
Type
string
Description
Unique identifier for the asset to assign to this device.
Name
protocol
Type
string
Description
The communication protocol used by the device.

Request

PUT

/v1/devices/xgQQXg3hrtjh7AvZ

curl -X PUT https://api.pointeron.com/v1/devices/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}" \
  -d 'name'="Updated Tracker 01"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "asset_id": "WAz8eIbvDR60rouK",
  "name": "Updated Tracker 01",
  "identifier": "GT06-ABC123",
  "protocol": "gt06",
  "is_online": true,
  "last_active_at": 705103200,
  "created_at": 692233200
}

DELETE/v1/devices/:id

Delete a device

This endpoint allows you to delete devices from your Pointeron organization. Note: This will permanently remove the device and stop all data ingestion from it.

Request

DELETE

/v1/devices/xgQQXg3hrtjh7AvZ

curl -X DELETE https://api.pointeron.com/v1/devices/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}"

Devices

The device model

Properties

Name
id
Type
string
Description
Unique identifier for the device.
Name
asset_id
Type
string
Description
Unique identifier for the asset assigned to this device.
Name
name
Type
string
Description
The display name for the device.
Name
identifier
Type
string
Description
The unique hardware identifier (IMEI, serial number, etc.).
Name
protocol
Type
string
Description
The communication protocol used by the device (e.g., http, gt06, h02).
Name
is_online
Type
boolean
Description
Whether the device is currently fresh/reachable according to its device-specific presence rules. For GPS trackers, a live command connection requires an active TCP session.
Name
last_active_at
Type
timestamp
Description
Timestamp of when the device last sent data.
Name
created_at
Type
timestamp
Description
Timestamp of when the device was registered.

GET/v1/devices

List all devices

This endpoint allows you to retrieve a paginated list of all your devices. By default, a maximum of ten devices are shown per page.

Optional attributes

Name
limit
Type
integer
Description
Limit the number of devices returned.
Name
online
Type
boolean
Description
Only show devices considered fresh/reachable by their device-specific presence rules when set to true.
Name
protocol
Type
string
Description
Only show devices using the specified protocol.
Name
asset_id
Type
string
Description
Only show devices for the specified asset.

Request

GET

/v1/devices

curl -G https://api.pointeron.com/v1/devices \
  -H "Authorization: Bearer {token}" \
  -d limit=10

Response

{
  "has_more": false,
  "data": [
    {
      "id": "xgQQXg3hrtjh7AvZ",
      "asset_id": "WAz8eIbvDR60rouK",
      "name": "Fleet Tracker 01",
      "identifier": "GT06-ABC123",
      "protocol": "gt06",
      "is_online": true,
      "last_active_at": 705103200,
      "created_at": 692233200
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}

POST/v1/devices

Register a device

This endpoint allows you to register a new tracking device in your Pointeron organization. An identifier is required to register a device.

Required attributes

Name
identifier
Type
string
Description
The unique hardware identifier (IMEI, serial number, etc.).
Name
name
Type
string
Description
The display name for the device.

Optional attributes

Name
asset_id
Type
string
Description
Unique identifier for the asset to assign to this device.
Name
protocol
Type
string
Description
The communication protocol used by the device.

Request

POST

/v1/devices

curl https://api.pointeron.com/v1/devices \
  -H "Authorization: Bearer {token}" \
  -d 'identifier'="GT06-ABC123" \
  -d 'name'="Fleet Tracker 01"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "asset_id": null,
  "name": "Fleet Tracker 01",
  "identifier": "GT06-ABC123",
  "protocol": null,
  "is_online": false,
  "last_active_at": null,
  "created_at": 692233200
}

GET/v1/devices/:id

Retrieve a device

This endpoint allows you to retrieve a device by providing the device id. Refer to the list at the top of this page to see which properties are included with device objects.

Request

GET

/v1/devices/xgQQXg3hrtjh7AvZ

curl https://api.pointeron.com/v1/devices/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "asset_id": "WAz8eIbvDR60rouK",
  "name": "Fleet Tracker 01",
  "identifier": "GT06-ABC123",
  "protocol": "gt06",
  "is_online": true,
  "last_active_at": 705103200,
  "created_at": 692233200
}

PUT/v1/devices/:id

Update a device

This endpoint allows you to perform an update on a device. Examples of updates are changing the name, assigning it to a different asset, or updating the protocol.

Optional attributes

Name
name
Type
string
Description
The new display name for the device.
Name
asset_id
Type
string
Description
Unique identifier for the asset to assign to this device.
Name
protocol
Type
string
Description
The communication protocol used by the device.

Request

PUT

/v1/devices/xgQQXg3hrtjh7AvZ

curl -X PUT https://api.pointeron.com/v1/devices/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}" \
  -d 'name'="Updated Tracker 01"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "asset_id": "WAz8eIbvDR60rouK",
  "name": "Updated Tracker 01",
  "identifier": "GT06-ABC123",
  "protocol": "gt06",
  "is_online": true,
  "last_active_at": 705103200,
  "created_at": 692233200
}

DELETE/v1/devices/:id

Delete a device

This endpoint allows you to delete devices from your Pointeron organization. Note: This will permanently remove the device and stop all data ingestion from it.

Request

DELETE

/v1/devices/xgQQXg3hrtjh7AvZ

curl -X DELETE https://api.pointeron.com/v1/devices/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}"