siblings_list

Returns list of siblings that have the same parents. 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_265

Body Params
integer
required

School year id

integer
Defaults to 0

Group level

string

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

string

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

integer
Defaults to 0

Gender

string

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

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