applicants_list

post

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

Returns a list of all applicants with their basic details, status and payment balance. 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: Manage Registration (#442)

Reference Code: srv_31

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

year_id

integer

required

School year id

groupLevelId

string

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

groupId

string

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

genderId

integer

Defaults to 0

Gender

dateRange

string

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

religionId

string

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

birthYear

string

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

balance

string

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

statusId

string

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

nationalityId

string

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

entranceRequirementTypeId

string

Has Interview / Exam Format: Comma separated numbers, i.e. 23,24,25

entranceRequirementId

string

Interview / Exam Format: Comma separated numbers, i.e. 23,24,25

sourceId

integer

Defaults to 0

Source

subStatusId

string

Sub-status 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