Guests

List the authenticated user's guests

Returns the list of guest invitations created by the authenticated user, with custom-named guests first and then alphabetically by name. Results are paginated.

get/v1/guests/

Request

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

Query parameters

pageinteger

Page number (page size is 500).

groupstring

Filter by group: a group id, or none for guests without any group.

Response

Paginated list of guests.

Example response

{
  "_embedded": {
    "guests": [
      {
        "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
          }
        ]
      }
    ]
  },
  "_links": [
    {
      "rel": "self"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.