Guests

Retrieve a single guest

Changed on

Returns the guest identified by guestId. The authenticated user must be the mentor that created it.

get/v1/guests/{guestId}/

Request

  • Base URL: https://api.educaplay.com
  • URL: https://api.educaplay.com/v1/guests/{guestId}/
  • Auth: HTTP bearer

Path parameters

guestIdinteger required

Numeric identifier of the guest.

Response

Guest details.

idinteger required
namestring required
codestring required

Auto-generated nine-letter access code in the form XXX-XXX-XXX. Share it with the guest to let them play the mentor's activities.

linkstring uri required

Direct access link. Opening it shows a confirmation screen ("Enter as …") and signs the guest in without typing the code. It is the same secret as the code: share it with the same care.

qrstring uri required

Content to encode in the guest's QR code. Educaplay does not render QR images server-side: it encodes this URL on the client with the same generator used for game QR codes, and so can you.

Example response

{
  "id": 12345,
  "name": "Alice",
  "code": "ABC-DEF-GHI",
  "_links": [
    {
      "rel": "self"
    }
  ],
  "link": "https://www.educaplay.com/login/invitation/ABC-DEF-GHI/",
  "qr": "https://www.educaplay.com/login/invitation/ABC-DEF-GHI/",
  "groups": [
    {
      "id": 42,
      "name": "3.º B",
      "count": 27
    }
  ]
}

Changes