users

post

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

List of all users in your account. By default you will get only users assigned to groups, but that can be changed by changing the value of the relevant parameter. For each user you will get basic details: user ID, name, groups, user type (s), permission roles. 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: MEDIUM

Permission needed: Search users (#500)

Reference Code: srv_214

Body Params

year_id

integer

required

School year id

userStatus

integer

Student status

classId

string

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

groupLevelId

integer

Defaults to 0

Group level

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

userTypeCode

string

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

userRoleId

string

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

balance

string

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

payments

string

Total payments Number range value. Format: Comma separated two numbers:-100,100

paymentPerc

string

Paid% 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

isAssignedToGroup

integer

Defaults to 2

Assigned to group?

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

Response

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

application/json

200OK

404Error