Institution Courses Report

Endpoint used to retrieve information about the courses available in the institution.

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/courses?page=1&perPage=20' \
  --header 'Authorization: Bearer <token>'

Response Example

{
  "data": {
    "current_page": 1,
    "from": 1,
    "last_page": 3,
    "to": 20,
    "total": 46,
    "data": [
      {
        "id": 1,
        "title": "<string>",
        "imageUrl": "<string>",
        "classrooms": [
          {
            "id": 1,
            "schoolId": 1,
            "title": "<string>",
            "code": "<string>"
          }
        ]
      }
    ],
    "links": {
      "first": "<string>",
      "last": "<string>",
      "prev": null,
      "next": "<string>"
    },
    "meta": {
      "current_page": 1,
      "from": 1,
      "last_page": 3,
      "path": "<string>",
      "per_page": 20,
      "to": 20,
      "total": 46,
      "links": [
        {
          "url": "<string>",
          "label": "<string>",
          "active": true
        }
      ]
    }
  }
}

---

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	string	Specifies the page number of results to be returned.	No
perPage	string	Defines the number of results per page.	No

---

Response description

Key	Type	Description
data	object	Contains the paginated listing of courses with their classes.
data.current_page	number	Current page of the listing.
data.from	number	Index of the first item on the current page.
data.last_page	number	Total number of available pages.
data.to	number	Index of the last item on the current page.
data.total	number	Total number of courses listed.
data.data	array	List of courses with related data.
data.data.id	number	Unique identifier of the course.
data.data.title	string	Course title.
data.data.imageUrl	string	URL of the course cover image.
data.data.classrooms	array	List of classes associated with the course.
data.data.classrooms.id	number	Unique identifier of the class.
data.data.classrooms.schoolId	number	School identifier to which the class belongs.
data.data.classrooms.title	string	Class title.
data.data.classrooms.code	string	Unique class code.
data.links	object	Pagination links.
data.links.first	string	URL of the first page.
data.links.last	string	URL of the last page.
data.links.prev	string	URL of the previous page (may be null).
data.links.next	string	URL of the next page (may be null).
data.meta	object	Additional pagination metadata.
data.meta.current_page	number	Current page.
data.meta.from	number	Starting index in the list.
data.meta.last_page	number	Last available page.
data.meta.path	string	Base path for pages.
data.meta.per_page	number	Number of items per page.
data.meta.to	number	Ending index on the current page.
data.meta.total	number	Total records found.
data.meta.links	array	List of pagination links.
data.meta.links.url	string	URL of the corresponding page (may be null).
data.meta.links.label	string	Descriptive label of the page.
data.meta.links.active	boolean	Indicates if this is the active page.

---

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.