School
List Schools
Returns a paginated list of all Schools in your organization.
get/school
Query parameters
limitinteger
Example:1
The maximum number of Schools to return (default: 50) when listing Schools
offsetinteger
The number of Schools to skip before starting to return results (default: 0) when listing Schools
Response
Response for School List operation - returns a paginated list of School
Example response
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"meta": {
"createdAt": "2024-01-15T10:30:00Z",
"createdBy": "987fcdeb-51a2-43d1-b567-123456789abc",
"updatedAt": "2024-01-15T14:45:00Z",
"updatedBy": "987fcdeb-51a2-43d1-b567-123456789abc"
},
"external": {
"sourceID": "12345678",
"source": "ExternalIntegrationAPI"
},
"title": "Meitner Grundskola",
"unitID": "123e4567-e89b-12d3-a456-426614174000",
"unitCode": "12345678",
"csnSchoolCode": "12345",
"municipalityCode": "0184",
"schoolType": "GR"
}
],
"pagination": {
"limit": 1,
"total": 100
}
}