Schools using an App

Partners can use the Eduplaces IDM to get a list of schools using their app. The amount of information available about each school depends on the permissions granted to the partner by Eduplaces. The list of schools should be used to build outstanding features that will help schools to use the app more effectively. It is important to note that the list should not be used to contact schools for marketing purposes or to share information with third parties.

Partners can access the list of schools in the context of a specific app. Only schools that enabled data sync for the requesting app will be listed.

Eduplaces API

`GET /schools`

Path	Authentication	Required Scope
`/idm/ep/v1/schools`	Access Token in the apps context (Client Credentials)	`urn:eduplaces:idm:v1:schools:read`

Provides a list of schools that have enabled data sync for the requesting app (based on the provided access token).


HTTP/1.1 200
Content-Type: application/json
 
[
  {
    "id": "25d185b6-fb83-44c1-aa6d-ee79d9c6b1fd",
    "name": "Schloss Einstein Internat",
    "address": {
      "address": "Einsteinallee 1",
      "addressAddition": "c/o Max Mustermann",
      "city": "Musterstadt",
      "zipCode": "38100"
    },
    "location": {
      "country": "DE",
      "state": "NI"
    },
    "officialId": "DE-NI-123456"
  },
  {
    "id": "1db34859-019f-42fa-9822-38b69c1deb5b",
    "name": "Löwenberg Schule",
    "address": {
      "address": "Löwenberg Str. 1",
      "addressAddition": null,
      "city": "Musterstadt",
      "zipCode": "38100"
    },
    "location": {
      "country": "DE",
      "state": "NI"
    },
    "officialId": "DE-NI-18K6"
  }
]

Receiving an empty array?
This endpoint only lists schools that enabled data sync for your app. If you receive an empty array, it means that no schools have enabled data sync for your app yet. This is an additional setting and not the same as granting access to your app. It is the expected behavior that not all schools you might know from SSO logins are listed here.
Refer to the Access vs. Sync page for more information on the difference between granting access to your app and enabling data sync.

`GET /schools/:id`

Path	Authentication	Required Scope
`/idm/ep/v1/schools/:id`	Access Token in the apps context (Client Credentials)	`urn:eduplaces:idm:v1:schools:read`

Gets a specific school by its ID.


HTTP/1.1 200
Content-Type: application/json
 
{
  "id": "25d185b6-fb83-44c1-aa6d-ee79d9c6b1fd",
  "name": "Schloss Einstein Internat",
  "address": {
    "address": "Einsteinallee 1",
    "addressAddition": "c/o Max Mustermann",
    "city": "Musterstadt",
    "zipCode": "38100"
  },
  "location": {
    "country": "DE",
    "state": "NI"
  },
  "officialId": "DE-NI-123456"
}

Receiving “404 Not Found: School not found for this app”?
This endpoint only returns schools that enabled data sync for your app. If a school you know from SSO logins is not found, it means that school did not enable data sync for your app. This is an additional setting and not the same as granting access to your app.
Refer to the Access vs. Sync page for more information on the difference between granting access to your app and enabling data sync.

SchulConneX

Unfortunately, the SchulConneX specification does not provide an endpoint to list schools (organizations) so far. We are in contact with the SchulConneX team to extend the specification and provide this feature in the future.