List Themes

This endpoint allows listing the available themes of the institution in Toolzz LMS.

Request Example

curl --request GET \
  --url 'https://kong.api.toolzz.com.br/api/content/get-all-themes?page=1&per_page=100' \
  --header 'Authorization: Bearer <token>'

Response Example

{
  "data": {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "instituicao_id": 123,
        "user_id": 456,
        "ciclo_id": 789,
        "titulo": "<string>",
        "tag": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "questions": [
          {
            "id": 1,
            "tipo": 1,
            "pergunta": "<string>",
            "tag": "<string>"
          }
        ]
      }
    ],
    "first_page_url": "<string>",
    "last_page": 10,
    "per_page": 10,
    "total": 100
  },
  "message": "Themes successfully listed"
}

---

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	Page number that will be returned (pagination starting at 1).	No
per_page	number	Amount of items per page (for pagination control).	No
search	string	Text search by keywords to filter themes by name or related attributes.	No

---

Response description

Key	Type	Description
data	object	Main API response containing the themes and pagination metadata.
data.current_page	number	Current page of the paginated query.
data.data	array	List of returned themes.
data.data.id	number	Unique ID of the theme.
data.data.instituicao_id	number	ID of the institution associated with the theme.
data.data.user_id	number	ID of the user who created the theme.
data.data.ciclo_id	number	ID of the associated educational cycle.
data.data.titulo	string	Title/name of the theme.
data.data.tag	string	Tags associated with the theme (separated by comma).
data.data.created_at	string	Theme creation date.
data.data.updated_at	string	Date of the last update of the theme.
data.data.questions	array	List of questions associated with the theme.
data.data.questions.id	number	Question ID.
data.data.questions.tipo	number	Question type (1=discursive, 2=multiple choice).
data.data.questions.pergunta	string	Question text (can contain HTML).
data.data.questions.tag	string	Tags associated with the question.
data.first_page_url	string	URL of the first page of results.
data.last_page	number	Number of the last available page.
data.per_page	number	Amount of items per page.
data.total	number	Total items available in the query.
message	string	Descriptive message about the operation result.

---

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.