---
title: "Fetch beacon list"
method: GET
path: "/beacon/fetch"
tags: ["Tracking|Beacon"]
---

# Fetch beacon list

`GET /beacon/fetch`

This endpoint retrieves a list of beacons with detailed information, including the current latitude and
longitude. Beacons are little devices that send a bluetooth signal. This bluetooth signal can be received by GPS
trackers or the geoCapture mobile application. If this occurs, the beacon's position will be updated to the
position of the tracker. Usually, beacons in geoCapture are affixed to tools or small machines.

## Query parameters

- `beacons[byIds][]` integer[]
- `beacons[byUuids][]` string[]
- `beacons[byToolIds][]` string[]
- `offset` integer
- `limit` integer

## Response `200`

Success Response:

- StandardBeaconFetchResponse
  - `data` object[] — The Beacons.
    - `id` integer — The internal ID.
    - `uuid` string — The beacon UUID as hexadecimal value.
    - `macAddress` string — The beacon MAC address.
    - `name` string — The name of the beacon. (max. 255 characters)
    - `objectIdentifier` string — External, customer specific ID of the object the beacon is attached to. (max. 64 characters)
    - `objectSerialNumber` string — Serial number of object, the beacon is attached to. (max. 128 characters)
    - `protocol` string — Thee beacon protocol.
    - `serialNumber` string — The serial number of the beacon.
    - `batteryPercentage` integer — The beacon's battery charge in percent.
    - `status` string — The current status of the beacon. | Value | Description | |---------------------|---------------------| | DEACTIVATED | The beacon is deactivated. | | LOST | The Beacon is reported lost. | | FOUND | The Beacon was reported lost but has now been found. | | DRIVING | The beacon is transported in a vehicle. | | HALT | The beacon is not connected to any project or gateway | | HALT_AT_GATEWAY | The beacon is at a gateway. The gateway is the currentTracker. | | HALT_AT_PROJECT | The Beacon is at a project. |
    - `currentLoss` BeaconFetchResponseBeaconLossItem
      - `description` string — Description of the loss.
      - `lastTracker` BeaconFetchResponseTrackerItem
        - `id` integer — The internal vehicle ID.
        - `identifier` string — The customer-specific ID. (max. 64 characters)
        - `inventoryNumber` string — The inventory number. (max. 128 characters)
        - `licenseNumber` string — The vehicle license plate. (max. 255 characters)
        - `identificationNumber` string — The vehicle identification number. (max. 24 characters)
        - `importSource` string — External data source from which this vehicle originates. (max. 64 characters)
        - `importKey` string — External ID from the respective data source. (max. 64 characters)
        - `name` string — The vehicle name. (max. 255 characters)
      - `lastLatLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
      - `lostAt` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `currentProject` BeaconFetchResponseProjectItem
      - `id` integer — The internal project ID.
      - `reference` string — The project number.
      - `importSource` string — External data source from which this project originated.
      - `importKey` string — External ID from the respective data source.
      - `name` string — The project name. (max. 255 characters)
      - `description` string — The project description.
      - `extraName1` string — The name1 address addition. (max. 255 characters)
      - `extraName2` string — The name2 address addition. (max. 255 characters)
      - `extraName3` string — The name3 address addition. (max. 255 characters)
      - `street` string — The street.
      - `zipCode` string — The zip code.
      - `city` string — The city.
      - `countryCode` string — The two-digit ISO 3166 country code.
      - `latLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
      - `costCenter` string — The cost center. (max. 64 characters)
    - `multipleProjectsPossible` boolean — Indicates if multiple current projects were possible.
    - `currentTracker` BeaconFetchResponseTrackerItem
      - `id` integer — The internal vehicle ID.
      - `identifier` string — The customer-specific ID. (max. 64 characters)
      - `inventoryNumber` string — The inventory number. (max. 128 characters)
      - `licenseNumber` string — The vehicle license plate. (max. 255 characters)
      - `identificationNumber` string — The vehicle identification number. (max. 24 characters)
      - `importSource` string — External data source from which this vehicle originates. (max. 64 characters)
      - `importKey` string — External ID from the respective data source. (max. 64 characters)
      - `name` string — The vehicle name. (max. 255 characters)
    - `latLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
    - `estimatedLatLng` number[] — Represents a geo coordinate. An array of two double values, representing the latitude and longitude.
    - `estimatedTracker` BeaconFetchResponseTrackerItem
      - `id` integer — The internal vehicle ID.
      - `identifier` string — The customer-specific ID. (max. 64 characters)
      - `inventoryNumber` string — The inventory number. (max. 128 characters)
      - `licenseNumber` string — The vehicle license plate. (max. 255 characters)
      - `identificationNumber` string — The vehicle identification number. (max. 24 characters)
      - `importSource` string — External data source from which this vehicle originates. (max. 64 characters)
      - `importKey` string — External ID from the respective data source. (max. 64 characters)
      - `name` string — The vehicle name. (max. 255 characters)
    - `temperature` number — The current outside temperature.
    - `lastSignalAt` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `estimatedLastSignalAt` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
  - `offset` integer — Number of skipped records.
  - `totalCount` integer — Total number of available beacons. (Calculated only if the offset is 0)

---

[API](https://skmtc.net/geocapture/apis/geocapture-api.md) · [All operations](https://skmtc.net/geocapture/apis/geocapture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/geocapture/geocapture-api/versions/15839b24c497/schema)