Skip to main content
GET
/
student
List Students
curl --request GET \
  --url https://api.meitner.se/data-export/v1/student \
  --header 'Client-ID: <api-key>' \
  --header 'Client-Secret: <api-key>'
{
  "data": [
    {
      "school": {
        "id": "12345678-1234-1234-1234-123456789012",
        "displayName": "Meitner Grundskola"
      },
      "student": {
        "id": "12345678-1234-1234-1234-123456789012",
        "identityNumber": "20000101-1234",
        "firstName": "John",
        "lastName": "Doe",
        "dateOfBirth": "2000-01-01",
        "gender": "Male",
        "schoolType": "GR",
        "schoolYear": "9"
      },
      "motherTongue": "SWE",
      "motherTongueParticipates": false,
      "modernLanguageInStudentsChoice": "DEU",
      "modernLanguageInLanguageChoice": "DEU",
      "swedishAsSecondLanguage": false,
      "isAbleToSwim": false,
      "hasActionProgram": false,
      "hasChildcare": false,
      "startDate": "2024-01-01",
      "endDate": "2024-01-01",
      "archiveYear": "2024_2025",
      "archiveTerm": "HT"
    }
  ],
  "pagination": {
    "offset": 0,
    "limit": 1,
    "total": 100
  }
}

Authorizations

​
Client-ID
string
header
required
​
Client-Secret
string
header
required

Query Parameters

​
limit
integer
default:50

The maximum number of Students to return (default: 50) when listing Students

Example:

1

​
offset
integer
default:0

The number of Students to skip before starting to return results (default: 0) when listing Students

Example:

0

Response

Response for Student List operation - returns a paginated list of Student

​
data
object[]

Array of Student objects

Example:
[
  {
    "school": {
      "id": "12345678-1234-1234-1234-123456789012",
      "displayName": "Meitner Grundskola"
    },
    "student": {
      "id": "12345678-1234-1234-1234-123456789012",
      "identityNumber": "20000101-1234",
      "firstName": "John",
      "lastName": "Doe",
      "dateOfBirth": "2000-01-01",
      "gender": "Male",
      "schoolType": "GR",
      "schoolYear": "9"
    },
    "motherTongue": "SWE",
    "motherTongueParticipates": false,
    "modernLanguageInStudentsChoice": "DEU",
    "modernLanguageInLanguageChoice": "DEU",
    "swedishAsSecondLanguage": false,
    "isAbleToSwim": false,
    "hasActionProgram": false,
    "hasChildcare": false,
    "startDate": "2024-01-01",
    "endDate": "2024-01-01",
    "archiveYear": "2024_2025",
    "archiveTerm": "HT"
  }
]
​
pagination
object

Pagination information

Example:
{ "offset": 0, "limit": 1, "total": 100 }