{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"d500d161-614f-4c83-9f85-63f9af5ab021","name":"eKool public API (v3)","description":"## eKool public API (v3)\n\nRESTful read API for authorized third-party platforms to access school data on behalf of an authenticated eKool user.\n\n### Hosts\n\n| | login (auth) | API |\n|---|---|---|\n| **Staging** | `https://login.ekool.dev` | `https://api-v2.ekool.dev` |\n| **Production** | `https://login.ekool.eu` | `https://api-v2.ekool.eu` |\n\nSet the collection variables `login_url` and `api_url` for the environment you target.\n\n### Authorization model\n\n- **OAuth 2.0 Authorization Code grant with PKCE** is required for every client. eKool does not issue client secrets — PKCE alone authenticates the token exchange.\n- The bearer access token is sent in the `Authorization` header for every API call: `Authorization: Bearer <access_token>`.\n- Tokens carry the partner's `client_id` and the scopes granted by the user during consent. eKool also tracks per-school **agreements** between the partner and each school.\n\n### Final access\n\n```\nFinal access = (Client scopes ∩ User-approved scopes) + Active school agreements\n```\n\n- Scopes control **which endpoints** the partner can call.\n- School agreements control **which schools** are reachable. Single-school endpoints reject schools without an agreement (`403 no_school_agreement`); the schools list endpoint exposes a per-item `has_agreement` flag.\n\n### Available scopes\n\n| Scope | Grants |\n|---|---|\n| `user:read` | `GET /api/v3/users/me` |\n| `schools:read` | `GET /api/v3/users/me/schools`, `GET /api/v3/schools/{id}/roles` |\n| `journals:read` | `GET /api/v3/schools/{id}/journals` |\n| `journal.students:read` | `GET /api/v3/schools/{id}/journals/{journal_id}/students` |\n\n### Response envelope\n\n**Success:**\n```json\n{\n  \"status\": true,\n  \"meta\": { \"total\": 42, \"last_page\": 3, \"current_page\": 1, \"per_page\": 20 },\n  \"data\": [ ... ]\n}\n```\n\n**Error:**\n```json\n{\n  \"status\": false,\n  \"errors\": [ { \"code\": 403, \"message\": \"not_allowed_action\" } ]\n}\n```\n\n- `code` is the numeric HTTP status code.\n- `message` is a short machine-readable identifier (`bad_request`, `not_allowed_action`, `no_school_agreement`, `data_not_found`, `invalid_context_role`, `journal_does_not_belong_to_school`) or a specific human-readable message.\n- `errors` is always an array; it may contain one or more entries.\n\n### Pagination\n\nList endpoints accept `page` (default `1`) and `per_page` (default `20`).\n\n### Onboarding\n\nTo create a new client, send an email to `help@ekool.eu` with:\n\n- the institution / company name;\n- the responsible person's name, e-mail and phone;\n- the integration use case;\n- one or more `redirect_uri` values (e.g. `https://my.application.com/oauth2/callback`).\n\nYou will receive a `client_id` and the list of granted scopes. eKool does not issue `client_secret` — every client (mobile, SPA, native, server-side) authenticates the token exchange with PKCE.\n\nKeep your `client_id` private and never embed it in user-visible source for higher-trust integrations. For partner-agreement onboarding (per-school access) eKool sets up the agreements on its side; partners do not manage them.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"17171853","team":2382674,"collectionId":"d500d161-614f-4c83-9f85-63f9af5ab021","publishedId":"2sBXqMHeSR","public":true,"publicUrl":"https://api-docs-public.ekool.eu","privateUrl":"https://go.postman.co/documentation/17171853-d500d161-614f-4c83-9f85-63f9af5ab021","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.12.10","publishDate":"2026-10-27T13:05:17.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/e6ae20cb8b8a3e0b9569fb9765ba7a7f98154f9df7b9811f7af0f2ae48d8f0a0","favicon":"https://res.cloudinary.com/postman/image/upload/v1648127255/team/vr3csuomo3ppzho7clda.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://api-docs-public.ekool.eu/view/metadata/2sBXqMHeSR"}