Fleet Data APIs

These endpoints allow you to securely access and interact with your fleet’s data, including device info, location updates, and trip history.

API Key Provisioning

  • Go to Developers tabs

  • On Fleet Data API Key click Generate API Key

  • Copy and save the key securely — it will only be shown once

Authorization

All API requests require the API Key in the header:

Authorization: Bearer <your API key>

Devices API

Endpoint

GET https://api.trybeekeeper.ai/v1/devices

Returns a list of all devices in your fleet.

Response Format

{
  "devices": [
    {
      "id": "string",
      "serialNumber": "string",
      "name": "string",
      "description": "string",
      "deviceModel": "string",
      "firmwareVersion": "string",
      "vehiclePlate": "string",
      "imei": "string"
    }
  ]
}

Location API

Endpoint

GET https://api.trybeekeeper.ai/v1/location

Query Params

  • deviceId (required)

Returns the latest known location of the specified device.

Response Format

Trips API

Endpoint

GET https://api.trybeekeeper.ai/v1/trips

Query Params

  • deviceId (required)

  • startDate (required, ISO format)

  • endDate (required, ISO format)

Returns trips taken by a device within a specified date range.

Response Format (truncated for clarity)

Rewards API

Lists rewards information for all devices in fleet, for a given reward period. A reward period is a calendar week.

Endpoint

GET https://api.trybeekeeper.ai/v1/hivemapperRewards

Query Params

  • rewardPeriod required. date must be a Monday e.g. 2025-05-12

Returns rewards for your devices in your fleet

Response Format

Last updated