student_roster

post

https://gw.edu-nation.net/api/student_roster

Get full information for all students in your account. By default you will get the built-in fields for students, and you can use the "additinal_fields" parameter to include more fields in the JSON results.
You can use the "additional_fields" parameter to include more fields in the JSON results. Check the /fields service to explore the additional fields that you can add.
Example:

{
"additional_fields":"customField_35,idnumber,countryName"
}

Rate Limit: LIGHT

Permission needed: View User Details Report (#568)

Reference Code: srv_177

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

year_id

integer

required

School year id

string

Search students by name, idnumber or user id

groupLevelId

integer

Defaults to 0

Group level

classId

string

Class
Format: Comma separated numbers, i.e. 23,24,25

genderCode

integer

Defaults to 0

Gender

nationalityId

string

Nationality
Format: Comma separated numbers, i.e. 23,24,25

birthYear

string

Birth Year
Number range value.
Format: Comma separated two numbers:-100,100

createdAt

string

Created At
Date range value.
Format: Comma separated dates: yyyy-MM-dd HH:mm:ss,yyyy-MM-dd HH:mm:ss

userStatus

integer

Student status

subjectId

string

Subject
Format: Comma separated numbers, i.e. 23,24,25

teacherId

string

Teacher
Format: Comma separated numbers, i.e. 23,24,25

religionId

string

Religion
Format: Comma separated numbers, i.e. 23,24,25

additional_fields

string

Include more fields in the JSON results. Check the /fields service to explore the additional fields that you can add.
Format: {"additional_fields":"customField_35,idnumber,countryName"}

Headers

client_secret

string

required

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

404Error