List Students in Course Package

Endpoint used to retrieve the students enrolled in a specific course package in Toolzz LMS.

Request Example

curl --request GET \
  --url 'https://kong.api.toolzz.com.br/api/plans/{plan_uuid}/users' \
  --header 'Authorization: Bearer <token>'

Response Example

{
  "data": [
    {
      "id": 1,
      "name": "<string>",
      "email": "<string>",
      "status": "active"
    }
  ]
}

---

Request description

Access Token

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

URL Parameters (Path)

Parameter	Type	Description	Required
plan_uuid	string	Identifier of the target package. Must be provided in the URL in place of {plan_uuid}.	Yes

---

Response description

Key	Type	Description
data	array	List of students enrolled in the package.
data.id	number	Unique identifier of the student.
data.name	string	Name of the student.
data.email	string	Email address of the student.
data.status	string	Student enrollment status.

---

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.