classes

GET

/api/v3/classes

Last modified:2026-01-23 08:42:04

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff 'https://prod.your-api-server.com/api/v3/classes?page=1&pagesize=100&filter[branchid]=1&filter[closed]=false&filter[archived]=false&filter[canceled]=false&filter[suspended]=false&filter[locationid]=378&filter[subjectid]=697&filter[classmodelid]=143&filter[teachingyearid]=15&filter[tagid]=1&filter[customercompanyid]=89&filter[classTeacher]=14777&filter[teacher2bedefined]=null&filter[isonline]=false&filter[isvirtual]=false&filter[ishybrid]=false&filter[allowsubscription]=false&filter[opensubscription]=false&filter[closedsubscription]=false&filter[selfbooking]=false&filter[exclusive]=false&filter[className]=School%20Level%201%20-%20Gruppo%201&filter[code]=1&filter[subject]=Inglese&filter[location]=Liceo%20Charles%20Baudelaire' \
--header 'Authorization: Basic <encoded-value>'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "data": [
        {
            "id": 14782,
            "username": null,
            "email": "bianchi@blucloud.it",
            "adminemail": null,
            "ssoemail": null,
            "name": "Laura",
            "surname": "Bianchi",
            "alias": null,
            "fullName": "Bianchi Laura",
            "taxcode": "BNCLRA14C08R978H",
            "taxcodevalid": 0,
            "vatnumber": "",
            "vatcodevalid": 0,
            "passport": null,
            "role": "student",
            "studentRollId": null,
            "birthday": 0,
            "gender": "male",
            "address": "Via Roma 5",
            "cap": "52100",
            "city": "Arezzo",
            "province": "AR",
            "mobileNo": "",
            "phoneNo": "",
            "isLeaderBoard": null,
            "defLang": 0,
            "appinvite": "1749632951",
            "appconnected": 1,
            "billingmethod": "none",
            "adminteacher": null,
            "admintype": 0,
            "subscriptionyear": "A.A. 2020/2021",
            "subscription": null,
            "shownclassrooms": null,
            "privacyok": null,
            "CV": null,
            "teacheronline": 1,
            "datebirth": null,
            "age": null,
            "pec": null,
            "profession": null,
            "maritalstatus": null,
            "qualification": null,
            "notes": null,
            "webregistration": 0,
            "pensioner": 0,
            "netaccessid": null,
            "tokenaccessid": null,
            "roleid": 0,
            "birthplace": null,
            "birthprovince": "AR",
            "supportchat": 0,
            "rate": null,
            "classrate": null,
            "lastversion": null,
            "gcal": 0,
            "lastnotify": null,
            "disableupdate": 0,
            "companyid": null,
            "externid": null,
            "haslocations": null,
            "studlocation": -1,
            "disabled": 0,
            "country": "IT",
            "invoicedataid": null,
            "passportinvoice": 0,
            "differentinvoicedata": null,
            "color": null,
            "hideincalendar": 0,
            "locksession": null,
            "teacherlessons": 0,
            "customercompanyid": null,
            "enableweb": 1,
            "disablelogin": 0,
            "lastwebaccess": "2025-06-24T13:43:52.000000Z",
            "leadstatus": null,
            "assignedto": 0,
            "updatedat": "2025-07-24T11:27:29.000000Z",
            "createdat": "2021-04-07T06:57:50.000000Z",
            "iban": null,
            "bic": null,
            "codicedestinatario": null,
            "branchid": null,
            "branchadmin": 0,
            "hasiol": 0,
            "hasmoodle": 0,
            "sharecontacts": 0,
            "priorityclass": null,
            "systemnewsletter": null,
            "limiteddidactic": 0,
            "hidestudentpay": 0,
            "nopersonalcalendar": 0,
            "expectedvalue": null,
            "expectedclose": null,
            "citizenship": "IT",
            "externuuid": null,
            "virtualibanid": null,
            "acquisition": null,
            "birthcountry": "IT",
            "gasecret": null,
            "isexamstaff": 0,
            "campdirector": 0
        }
    ],
    "links": {
        "first": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=1",
        "last": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=22",
        "prev": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=2",
        "next": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=4"
    },
    "meta": {
        "current_page": 3,
        "from": 3,
        "last_page": 22,
        "links": [
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=2",
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=1",
                "label": "1",
                "active": false
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=2",
                "label": "2",
                "active": false
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=3",
                "label": "3",
                "active": true
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=4",
                "label": "4",
                "active": false
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=5",
                "label": "5",
                "active": false
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=6",
                "label": "6",
                "active": false
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=7",
                "label": "7",
                "active": false
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=8",
                "label": "8",
                "active": false
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=9",
                "label": "9",
                "active": false
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=10",
                "label": "10",
                "active": false
            },
            {
                "url": null,
                "label": "...",
                "active": false
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=21",
                "label": "21",
                "active": false
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=22",
                "label": "22",
                "active": false
            },
            {
                "url": "http://demolingue.blucloud.local:3000/api/v3/students?pagesize=1&page=4",
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "http://demolingue.blucloud.local:3000/api/v3/students",
        "per_page": 1,
        "to": 3,
        "total": 22
    }
}

Modified at 2026-01-23 08:42:04

Returns list of all locations

classes/{id}