This function returns a potentially filtered list of users for a school district or building.
listUsers(active = T, building_id = NULL, role_ids = NULL, parent_access_codes = NULL, school_uids = NULL, extended = NULL)
| active | Whether to return active users only. Defaults to True. |
|---|---|
| building_id | Specifies the building from which to return students. Leave NULL to return users from all school buildings. |
| role_ids | Specifies the roles for which to return students. Leave NULL to return users from of all roles. |
| parent_access_codes | Specifies whether parent access codes should be returned for each user. |
| school_uids | Specifies whether school uids should be returned for students. |
| extended | Whether to return extended details about a user. |
| start | Index of first record to return. Min value is 0. |
| limit | Number of records to return. Default is 20. Max value is 200. |
A dataframe of user details.
A user is a person associated with a school district.