Use this endpoint to fetch a school's learners and optionally include the parent info and the accountable person's details.
By default, only persons with active accounts (current learners or accounts with an outstanding balance) will be returned. You can use the all_accounts query parameter to fetch accountable persons for all accounts (includes left learners and 0 balance accounts).
To include parent info use the include_parents query parameter to include parent info in the response. For including the accountable person's details, use the include_accountable_person query parameter.
Optionally it is possible to filter on a specific learner_id, debtor_code or accountable_person_id.
Path Parameters
Name
Type
Description
Headers
Name
Type
Description
Query Parameters
Name
Type
Description
Response Examples
Code Samples
school_login_id*
Integer
The login ID of the school to retrieve data from
HTTP-X-USERNAME*
String
As provided by d6
HTTP-X-PASSWORD*
String
As provided by d6
learner_id
Integer
The ID of a specific learner
all_accounts
Boolean
Whether to include all accounts
include_parents
Boolean
Whether to include the parent data in the response
include_accountable_person
Boolean
Whether to include the accountable person's data in the response