List Contents

This endpoint allows listing or exporting the contents of your institution in Toolzz LMS.

Request Example

curl --request GET \
  --url 'https://kong.api.toolzz.com.br/api/content' \
  --header 'Authorization: Bearer <token>'

Response Example

{
  "success": true,
  "contents": {
    "current_page": 1,
    "data": [
      {
        "id": 1,
        "title": "<string>",
        "description": "<string>",
        "contentType": "video",
        "contentUrl": "<string>",
        "isPublic": true,
        "createdAt": "2024-08-12T10:42:31.000000Z"
      }
    ],
    "first_page_url": "<string>",
    "from": 1,
    "last_page": 10,
    "last_page_url": "<string>",
    "links": [
      {
        "url": "<string>",
        "label": "1",
        "active": true
      }
    ],
    "next_page_url": "<string>",
    "path": "<string>",
    "per_page": 15,
    "prev_page_url": null,
    "to": 15,
    "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
type	string	Filters contents by type. Accepted values: text, audio, video, pdf, live.	No
course_id	integer	Filters contents from a specific course based on the course ID.	No
does_sendemail	boolean	Set to 1 to receive a file with the listed contents by email.	No
email_to_send	string	Email address to which the generated file will be sent.	No
public	boolean	Allows searching for standalone contents in the catalog.	No
tags	string	Allows searching by tags associated with the content.	No
per_page	integer	Number of records returned per page in pagination.	No
query	string	Filters data by title and description. For ID-based search, use comma-separated numbers (e.g., 1,2).	No
contents_ids	string	Filters by content IDs.	No

---

Response description

Key	Type	Description
success	boolean	Indicates whether the request was completed successfully.
contents	object	Main object containing the paginated list of contents.
contents.current_page	number	Current page number returned in the pagination.
contents.data	array	List of contents returned on this page.
contents.data.id	number	Unique identifier of the content.
contents.data.title	string	Title of the content.
contents.data.description	string	HTML description of the content, used for initial presentation.
contents.data.contentType	string	Content type (e.g., text, video, quiz).
contents.data.contentUrl	string	URL to view the full content.
contents.data.isPublic	boolean	Defines whether the content is publicly accessible (true) or restricted (false).
contents.data.createdAt	string	Content creation date in ISO 8601 format (e.g., 2024-08-12T10:42:31.000000Z).
contents.first_page_url	string	URL of the first page of the listing.
contents.from	number	Index of the first item displayed on this page.
contents.last_page	number	Total number of available pages.
contents.last_page_url	string	URL of the last page of the listing.
contents.links	array	List of objects representing pagination navigation links.
contents.links.url	string	URL for the page indicated in the label (may be null for disabled links).
contents.links.label	string	Text displayed in the navigation control (e.g., 1, « Previous).
contents.links.active	boolean	Indicates whether the item represents the currently active page.
contents.next_page_url	string	URL of the next page (or null if it is the last page).
contents.path	string	Base API path used in pagination.
contents.per_page	number	Number of items returned per page.
contents.prev_page_url	string	URL of the previous page (or null if it is the first).
contents.to	number	Index of the last item on the current page.
contents.total	number	Total items available in the listing.

---

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.