Skip to navigation
API ReferenceBeacons

GetBeacon

GetBeacon returns one of the team's beacons by id.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Path parameters

idstringRequiredformat: "uuid"1-36 characters
Identifier of the resource, assigned by Edulead and opaque to callers.

Headers

Edulead-TeamstringRequired

Response

Success
beaconobjectOptional

Beacon is a named list of institutions. update_time moves on every change of the name or the institutions.