GET beacons/…

Retrieves all defined beacons for the caller's organization.

Resource URL

https://www.drillster.com/api/2.1.1/beacons/{organization_id?}

Parameters

Field	Type	Description
`organization_id` optional	String	The organization to retrieve the beacon definitions for. This is for internal use only.
`query` optional	String	An optional search query to reduce the number of beacons returned. Beacons can be queried by (parts of) the playable name or their description. Example value: `B747`

Response

A 2.1.1 Beacons object.

Example request

GET https://www.drillster.com/api/2.1.1/beacons/

Response

{
  "beacons": [{
    "id": "07212ead-8344-4426-8b41-8b0cb621625a_0000_0001",
    "proximity": "FAR",
    "lingerDuration": "PT5M",
    "description": "iBeacon in main hall",
    "playable": {
      "id": "5xGkjFr2vfbptyUTsTmimg",
      "type": "DRILL",
      "name": "17th Century Painters",
      "icon": {
        "type": "image/png",
        "url": "https://www.drillster.com/bin/feature/a17a4311cb2bd2dfee8c60037995a30b4ff37dab"
      }
    }
  }, {
    "id": "07212ead-8344-4426-8b41-8b0cb621625a_0000_0002",
    "proximity": "NEAR",
    "lingerDuration": "PT25M",
    "playable": {
      "id": "StpFP7LctGCsYOMX2vIBgw",
      "type": "TEST",
      "name": "Test about the 17th century",
      "icon": {
        "type": "image/png",
        "url": "https://www.drillster.com/bin/feature/b23a4311cb2bd2dfee8c60037995a30b4ff37986"
      }
    }
  }, {
    "id": "07212ead-8344-4426-8b41-8b0cb621625a_0000_aaaa",
    "proximity": "FAR",
    "lingerDuration": "PT30M",
    "playable": {
      "id": "5xGkjFr2vfbptyUTsTmimg",
      "type": "DRILL",
      "name": "Test drill",
      "icon": {
        "type": "image/png",
        "url": "https://www.drillster.com/bin/feature/b23a772bd2dfee8c60037995a30b4ff37986def0"
      }
    }
  }],
  "total":3
}

Error responses

The following error situations are possible:

ID	Response code	Description
`not_permitted`	403 (Forbidden)	Functionality not available to basic users.
`no_access`	401 (Unauthorized)	No access to other organization's beacon definitions.
`internal_error`	500 (Internal error)	Could not load playable object.

Last updated on 2025-04-18