List Devices

{
  "devices": [
    {
      "short_id": "a1b2c3d4",
      "hardware_id": "ABC123",
      "device_type": "teebox",
      "name": " ",
      "attributes": {
        "lat": 37.7749,
        "long": -122.4194,
        "battery_voltage": 12.4,
        "lock_status": 0
      },
      "is_online": true,
      "created_at": "2025-12-01T00:00:00.000Z",
      "updated_at": "2025-12-17T10:30:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "returned": 1
  }
}

GET

devices

{
  "devices": [
    {
      "short_id": "a1b2c3d4",
      "hardware_id": "ABC123",
      "device_type": "teebox",
      "name": " ",
      "attributes": {
        "lat": 37.7749,
        "long": -122.4194,
        "battery_voltage": 12.4,
        "lock_status": 0
      },
      "is_online": true,
      "created_at": "2025-12-01T00:00:00.000Z",
      "updated_at": "2025-12-17T10:30:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "returned": 1
  }
}

Returns a paginated list of devices. Results are automatically scoped to devices you have access to.

Query parameters

string[]

Filter by hardware IDs. Repeated (?hardware_ids=id1&hardware_ids=id2) or comma-separated (?hardware_ids=id1%2Cid2). Only hardware_id is accepted — filtering by short_id is not supported.

string

Filter by device type (e.g. teebox, cartcaddie).

string

Partial match across name, hardware_id, and short_id (case-insensitive).

string

Filter by device attribute (e.g. attr_lock_status=0).

number

default:"100"

Max results per page (1–1000).

number

default:"0"

Number of results to skip for pagination.

Response

object[]

required

Array of device objects.

Show Device object

string

required

Short, human-friendly device identifier.

string

required

Hardware identifier.

string

required

Device type (e.g. teebox, cartcaddie).

string

Display name.

object

required

Latest telemetry attributes (lat, long, battery_voltage, lock_status, etc.).

boolean

Whether the device is currently connected.

string

required

ISO 8601 creation timestamp.

string

required

ISO 8601 last update timestamp.

object

required

Show Pagination object

number

required

Requested page size.

number

required

Requested offset.

number

required

Number of results in this page. When returned < limit, you’ve reached the last page.

bash curl -H "X-API-Key: YOUR_API_KEY" \ "https://your-api-host/devices?device_type=teebox&limit=50"

{
  "devices": [
    {
      "short_id": "a1b2c3d4",
      "hardware_id": "ABC123",
      "device_type": "teebox",
      "name": " ",
      "attributes": {
        "lat": 37.7749,
        "long": -122.4194,
        "battery_voltage": 12.4,
        "lock_status": 0
      },
      "is_online": true,
      "created_at": "2025-12-01T00:00:00.000Z",
      "updated_at": "2025-12-17T10:30:00.000Z"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "returned": 1
  }
}

Devices

Telemetry

Lock Events

Trips

WebSocket

Query parameters

Response

​Query parameters

​Response

Query parameters

Response