List Institution Filters

Endpoint used to retrieve filters (groups, subgroups, and specialties) from an institution or school in Toolzz LMS.

Request Example

curl --request GET \
  --url 'https://kong.api.toolzz.com.br/api/catalog/list-filters?category=group' \
  --header 'Authorization: Bearer <token>'

Response Example

{
  "data": [
    {
      "id": 1,
      "name": "<string>",
      "category": "group"
    }
  ]
}

---

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
category	string	Limits the result to selected categories. Accepts: group, subgroup, or specialty.	Yes
school_id	int	School identifier to get filters for.	No

---

Response description

Key	Type	Description
data	array	List of filters.
data.id	number	Unique identifier of the filter.
data.name	string	Name of the filter.
data.category	string	Category of the filter (group, subgroup, or specialty).

---

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.