Students

Students

For Partners who need to access student information, the K12NET API provides an endpoint that supports paging, filtering, and sorting:


POST https://api.k12net.com/INTCore.Web/api/Partner/Organizations/{organization_id}/Students
    
    

Replace {organization_id} with the identifier of the Organization (or school) whose students you want to retrieve. The endpoint returns the students actively enrolled in the active school year of the Organization's schools, limited to the grade levels the Organization has shared with your Partner account.

Features of the Students Endpoint:

The fields that can be used in $where and $orderby are listed on the Filtering And Sorting page.

Sample Request for Paging:

Here is an example of a JSON object that can be posted to the endpoint to retrieve a slice of student records:


{
    "$skip": 20,
    "$take": 10,
    "$includeTotalCount": true
}
    

The $skip parameter specifies the number of records to skip before returning the results, while $take indicates the number of records to include in the response.

If you set $includeTotalCount to true, the total number of matching records is returned in the response header named TotalCount, so you can determine how many pages to request.

Sample Response:


[
    {
        "ID": "365ffb89-8c91-f111-8fbf-98f2b32a1389",
        "FullName": "Elif Yılmaz",
        "FullNameParts": { "First": "Elif", "Middle": null, "Last": "Yılmaz", "Suffix": null },
        "OtherName": null,
        "NationalID": "12345678901",
        "BirthDate": "2015-04-21T00:00:00",
        "Gender": false,
        "PhoneNumbers": [ "+90 555 000 00 00" ],
        "Emails": [ "[email protected]" ],
        "UserName": "elif.yilmaz",
        "Enrollment": {
            "ID": "395ffb89-8c91-f111-8fbf-98f2b32a1389",
            "YearID": 2027,
            "GradeLevel": "05",
            "Track": null,
            "LocalId": "512",
            "Homeroom": "5/A",
            "EntryDate": "2026-08-06T00:00:00",
            "School": { "ID": "64d249ec-4b35-4f30-a316-d045e105f827", "Name": "Example Middle School", "LocalId": "2" },
            "UsingBus": false
        }
    }
]
    
FieldDescription
IDUnique identifier of the student.
FullNameFull name of the student.
FullNamePartsThe name split into First, Middle, Last and Suffix. Empty parts are null; depending on how the school records names, all given names may be in First.
OtherName, OtherNamePartsThe student's name in English, when the school records one.
NationalIDNational identification number.
BirthDateDate of birth.
Gendertrue for male, false for female, null when unknown.
PhoneNumbers, EmailsPhone numbers and e-mail addresses of the student.
UserNameThe student's K12NET user name.
Enrollment.IDUnique identifier of the enrollment.
Enrollment.YearIDSchool year, identified by the year it ends in (2027 = the 2026-2027 school year).
Enrollment.GradeLevel, Enrollment.TrackGrade level code and, when the school defines them, the grade level's additional codes (comma-separated).
Enrollment.LocalIdThe student's school number.
Enrollment.HomeroomHomeroom (class) of the student.
Enrollment.EntryDateDate the student entered the school.
Enrollment.SchoolID, Name and LocalId of the school.
Enrollment.UsingBusWhether the student uses school transportation.

Controlling Data Fields:

The fields returned from the Students endpoint are controlled by the Organization. The data you receive may vary between Organizations depending on their configuration and data sharing policies; fields that are not shared are returned as null or are left out of the response. Responses may also contain the serializer properties $id and $type, which you can ignore.

When implementing this endpoint in your application, include appropriate error handling and data validation to accommodate the flexible nature of the returned data. This ensures that your application can robustly interact with the diverse datasets of students across K12NET Organizations.