---
title: "Get a beacon by its region and minor"
method: GET
path: "/beacon/forregion/{region}/{minor}"
tags: ["Beacon"]
---

# Get a beacon by its region and minor

`GET /beacon/forregion/{region}/{minor}`

## Request

- Base URL: `https://cloud.notifica.re/api`
- URL: `https://cloud.notifica.re/api/beacon/forregion/{region}/{minor}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/notificare/apis/notificare-cloud-api/docs/beacon/forregion/:region/:minor/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a beacon by its region and minor

## Path parameters

- `region` string, required
- `minor` string, required

## Response `200`

OK

- object
  - `beacon` BeaconModel
    - `_id` string: Notificare ID of the beacon
    - `batteryLevel` number: An object representing the battery level of this beacon.
    - `data` object: A free form object that can be assigned to a beacon.
    - `latitude` number: An integer representing the beacon's latitude.
    - `longitude` number: An integer representing the beacon's longitude.
    - `minor` number: Your beacon's minor identifier (must be unique per major)
    - `name` string: Your beacon's name
    - `notification` string: An Id of a previously created notification.
    - `proximity` 'immediate' | 'near' | 'far': Your notification proximity. Accepts one of these: 'immediate', 'near' and 'far'. (deprecated)
    - `proximityNotifications` object: An object containing three previously created message Ids for each proximity level.
      - `far` string
      - `immediate` string
      - `near` string
    - `purpose` string: An object representing the purpose of the beacon. Accepts one of these: 'general', 'pay', 'info', 'staff', 'admin'.
    - `triggers` boolean: Set to true if this beacon can be used in triggers. Max. number of beacons that can use triggers is limited to 10.

## Changes

- **2020-03-11** `5ed31e104b6f`: 1 info
  - the endpoint scheme security `ApplicationSecret` was added to the API

[Operation history](https://skmtc.dev/notificare/apis/notificare-cloud-api/changes/beacon/forregion/:region/:minor/get.md)

---

[API](https://skmtc.dev/notificare/apis/notificare-cloud-api.md) - [All operations](https://skmtc.dev/notificare/apis/notificare-cloud-api/llms.txt) - [OpenAPI document](https://skmtc.dev/notificare/apis/notificare-cloud-api/revisions/aad692b34bab?raw)