List Units

Endpoint used to list the school units of your institution, with all their data and settings. Search specifically by unit name, contract number, or URL slug.

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

Response Example

{
  "data": [
    {
      "id": 1,
      "name": "<string>",
      "urlSlug": "<string>",
      "contractNumber": "<string>",
      "tags": [],
      "taxId": "<string>",
      "group": [{ "id": 1, "name": "<string>" }],
      "subgroups": [],
      "specialties": [],
      "colorScheme": {
        "primary": "<string>",
        "secondary": "<string>",
        "buttonText": "<string>"
      },
      "social": {},
      "location": {
        "street": "<string>",
        "number": "<string>",
        "additionalDetails": "<string>",
        "district": "<string>",
        "city": "<string>",
        "state": "<string>",
        "zipCode": "<string>"
      },
      "features": {
        "enableTeacherRegistration": true,
        "enableStudentRegistration": true,
        "enableGoogleLogin": false,
        "enableLoginByDocument": false,
        "enableLoginByEmail": true,
        "enableForum": true,
        "enableViewCounter": true,
        "enableRating": true,
        "isPartOfProgram": false,
        "enableReviews": true,
        "showSchoolIconInMenu": true,
        "showIconDetails": true,
        "replicateInstitutionMenuLinks": false,
        "displaySchoolAccessButton": true
      },
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "meta": {
    "total": 100,
    "per_page": "20",
    "current_page": 1,
    "last_page": 5,
    "first_page_url": "<string>",
    "last_page_url": "<string>",
    "next_page_url": "<string>",
    "prev_page_url": null,
    "from": 1,
    "to": 20
  }
}

---

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
name	string	Filter units by name.	No
contractNumber	string	Filter units by contract number.	No
urlSlug	string	Filter units by URL slug.	No
page	string	Page number of unit records to display.	No
perPage	string	Number of records to display per page. Maximum allowed: 100.	No

---

Response description

Key	Type	Description
data	array	List of educational units.
data.id	number	Unique identifier of the unit.
data.name	string	Name of the unit.
data.urlSlug	string	URL slug of the unit.
data.contractNumber	string	Contract number associated with the unit.
data.tags	array	Tags associated with the unit.
data.taxId	string	Tax identification number (may be null).
data.group	array	List of groups associated with the unit.
data.subgroups	array	List of subgroups associated with the unit (empty if none).
data.specialties	array	List of specialties associated with the unit (empty if none).
data.colorScheme	object	Color scheme configuration.
data.colorScheme.primary	string	Primary color code.
data.colorScheme.secondary	string	Secondary color code.
data.colorScheme.buttonText	string	Button text color code.
data.social	object	Social media information (may be null).
data.location	object	Location details of the unit.
data.location.street	string	Street name.
data.location.number	string	Street number.
data.location.additionalDetails	string	Additional location details.
data.location.district	string	Neighborhood name.
data.location.city	string	City name.
data.location.state	string	State abbreviation.
data.location.zipCode	string	ZIP code.
data.features	object	Features enabled for the unit.
data.features.enableTeacherRegistration	boolean	Whether teacher registration is enabled.
data.features.enableStudentRegistration	boolean	Whether student registration is enabled.
data.features.enableGoogleLogin	boolean	Whether Google login is enabled.
data.features.enableLoginByDocument	boolean	Whether document login is enabled.
data.features.enableLoginByEmail	boolean	Whether email login is enabled.
data.features.enableForum	boolean	Whether the forum is enabled.
data.features.enableViewCounter	boolean	Whether the view counter is enabled.
data.features.enableRating	boolean	Whether rating is enabled.
data.features.isPartOfProgram	boolean	Whether the unit is part of a program.
data.features.enableReviews	boolean	Whether reviews are enabled.
data.features.showSchoolIconInMenu	boolean	Whether the school icon is shown in the menu.
data.features.showIconDetails	boolean	Whether icon details are shown.
data.features.replicateInstitutionMenuLinks	boolean	Whether institution menu links are replicated.
data.features.displaySchoolAccessButton	boolean	Whether the school access button is displayed.
data.createdAt	string	Date and time the unit was created.
data.updatedAt	string	Date and time the unit was last updated.
meta	object	Pagination metadata.
meta.total	number	Total number of records.
meta.per_page	string	Number of records per page.
meta.current_page	number	Current page number.
meta.last_page	number	Last page number.
meta.first_page_url	string	URL of the first page.
meta.last_page_url	string	URL of the last page.
meta.next_page_url	string	URL of the next page (may be null).
meta.prev_page_url	string	URL of the previous page (may be null).
meta.from	number	First record number on the current page.
meta.to	number	Last record number on the current 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.