| Name | Description | Type | Additional information |
|---|---|---|---|
| Country |
The student birth country as a two-character ISO code. Optional. |
string |
Matching regular expression pattern: [A-Za-z]{2} String length: inclusive between 2 and 2 |
| ProgramCountry |
The program country as a two-character ISO code. Optional. Defaults to US. |
string |
Matching regular expression pattern: [A-Za-z]{2} String length: inclusive between 2 and 2 |
| Gender |
The student gender as a string (either 'female' or 'male'). Optional. |
string |
Matching regular expression pattern: (female|male) |
| OnlyFutureStarts |
Whether to leave out students who are still application complete. Optional. |
boolean |
None. |
| IecId |
The IEC whose lead page is being rendered. When set, the only welcome students listed are those whose welcome host family is that IEC. Optional. |
integer |
Range: inclusive between 1 and 2147483647 |
| Age |
The student age in the range 14 to 18 (inclusive). Optional. |
integer |
Range: inclusive between 14 and 18 |
| Hobby |
One hobby for the student. Optional. |
string |
Matching regular expression pattern: [A-Za-z0-9 ]{0,100} String length: inclusive between 0 and 100 |
| From |
The amount of hits to skip. Used for pagination. Optional, defaults to zero. |
integer |
Range: inclusive between 0 and 2147483647 |
| Size |
The amount of hits to return. Used for pagination. Optional, defaults to 20. |
integer |
Range: inclusive between 0 and 50 |