Assets

Assets are a core part of Pointeron — they represent the vehicles, people, or objects you are tracking. On this page, we'll dive into the different asset endpoints you can use to manage assets programmatically. We'll look at how to query, create, update, and delete assets.

The asset model

The asset model contains all the information about your tracked assets, such as their name, type, and associated metadata. It also contains a reference to the device assigned to the asset and information about its last known location.

Properties

Name
id
Type
string
Description
Unique identifier for the asset.
Name
name
Type
string
Description
The name for the asset.
Name
type
Type
string
Description
The type of asset (e.g., vehicle, person, equipment).
Name
icon_url
Type
string
Description
The icon image URL for the asset.
Name
display_name
Type
string
Description
The asset display name in the dashboard. By default, this is just the name.
Name
device_id
Type
string
Description
Unique identifier for the device associated with the asset.
Name
last_active_at
Type
timestamp
Description
Timestamp of when the asset was last active on the platform.
Name
created_at
Type
timestamp
Description
Timestamp of when the asset was created.

GET/v1/assets

List all assets

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

Optional attributes

Name
limit
Type
integer
Description
Limit the number of assets returned.

Request

GET

/v1/assets

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

Response

{
  "has_more": false,
  "data": [
    {
      "id": "WAz8eIbvDR60rouK",
      "name": "Fleet Truck 01",
      "type": "vehicle",
      "icon_url": "https://assets.pointeron.com/icons/truck.png",
      "display_name": null,
      "device_id": "xgQQXg3hrtjh7AvZ",
      "last_active_at": 705103200,
      "created_at": 692233200
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}

POST/v1/assets

Create an asset

This endpoint allows you to add a new asset to your organization in Pointeron. To add an asset, you must provide a name and type.

Required attributes

Name
name
Type
string
Description
The name for the asset.
Name
type
Type
string
Description
The type of asset (e.g., vehicle, person, equipment).

Optional attributes

Name
icon_url
Type
string
Description
The icon image URL for the asset.
Name
display_name
Type
string
Description
The asset display name in the dashboard. By default, this is just the name.

Request

POST

/v1/assets

curl https://api.pointeron.com/v1/assets \
  -H "Authorization: Bearer {token}" \
  -d name="Fleet Truck 01" \
  -d type="vehicle" \
  -d icon_url="https://assets.pointeron.com/icons/truck.png"

Response

{
  "id": "WAz8eIbvDR60rouK",
  "name": "Fleet Truck 01",
  "type": "vehicle",
  "icon_url": "https://assets.pointeron.com/icons/truck.png",
  "display_name": null,
  "device_id": null,
  "last_active_at": null,
  "created_at": 692233200
}

GET/v1/assets/:id

Retrieve an asset

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

Request

GET

/v1/assets/WAz8eIbvDR60rouK

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

Response

{
  "id": "WAz8eIbvDR60rouK",
  "name": "Fleet Truck 01",
  "type": "vehicle",
  "icon_url": "https://assets.pointeron.com/icons/truck.png",
  "display_name": null,
  "device_id": "xgQQXg3hrtjh7AvZ",
  "last_active_at": 705103200,
  "created_at": 692233200
}

PUT/v1/assets/:id

Update an asset

This endpoint allows you to perform an update on an asset. Currently, the attributes that can be updated on assets are the display_name and icon_url which control how an asset appears in your dashboard in Pointeron.

Optional attributes

Name
display_name
Type
string
Description
The asset display name in the dashboard. By default, this is just the name.

Request

PUT

/v1/assets/WAz8eIbvDR60rouK

curl -X PUT https://api.pointeron.com/v1/assets/WAz8eIbvDR60rouK \
  -H "Authorization: Bearer {token}" \
  -d display_name="Main Delivery Truck"

Response

{
  "id": "WAz8eIbvDR60rouK",
  "name": "Fleet Truck 01",
  "type": "vehicle",
  "icon_url": "https://assets.pointeron.com/icons/truck.png",
  "display_name": "Main Delivery Truck",
  "device_id": "xgQQXg3hrtjh7AvZ",
  "last_active_at": 705103200,
  "created_at": 692233200
}

DELETE/v1/assets/:id

Delete an asset

This endpoint allows you to delete assets from your organization in Pointeron. Note: This will also unassign any devices associated with the given asset.

Request

DELETE

/v1/assets/WAz8eIbvDR60rouK

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