Unenrolled Users Report

Endpoint used to retrieve a detailed listing of users who are currently not enrolled in any course in Toolzz LMS.

Warning: This endpoint will only work correctly if the domain of your institution is manually provided in the URL. Otherwise, the endpoint may fail or return a validation error.

Request Example

curl --request GET \
  --url 'https://{your-institution-domain}/api/v1/reports/students/not-enrolled?page=1&perPage=20' \
  --header 'Authorization: Bearer <token>'

Response Example

{
  "data": [
    {
      "id": 1,
      "name": "<string>",
      "birthDate": "<string>",
      "document": "<string>",
      "mailAddress": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "lastActivity": 123,
      "lastLogin": "<string>"
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": null,
    "next": "<string>"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "links": [],
    "path": "<string>",
    "per_page": 20,
    "to": 20,
    "total": 100
  }
}

---

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

URL Parameters (Query)

Parameter	Type	Description	Required
page	number	Specifies the page number of results to be returned.	No
perPage	number	Defines the number of users to display per page.	No

---

Response description

Key	Type	Description
data	array	List of unenrolled users.
data.id	number	Unique identifier of the user.
data.name	string	Full name of the user.
data.birthDate	string	Date of birth in YYYY-MM-DD format.
data.document	string	User document (CPF, RG, etc.).
data.mailAddress	string	Email address of the user.
data.createdAt	string	Date of record creation.
data.updatedAt	string	Date of last record update.
data.lastActivity	number	Last recorded activity (timestamp or numeric value).
data.lastLogin	string	Date and time of last login.
links	object	Navigation URLs between report pages.
links.first	string	URL of the first page.
links.last	string	URL of the last page.
links.prev	string	URL of the previous page.
links.next	string	URL of the next page.
meta	object	Meta information about the result pagination.
meta.current_page	number	Current page.
meta.from	number	Index of the first item displayed.
meta.last_page	number	Last available page.
meta.links	array	List of pagination links.
meta.path	string	Base path for navigation.
meta.per_page	number	Number of items per page.
meta.to	number	Index of the last item displayed.
meta.total	number	Total available items.

---

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.