GET user list

Tien Bui

https://developer.sky.blackbaud.com/docs/services/school/operations/v1usersget

<span>https://api.sky.blackbaud.com/school/v1/users?roles={<strong>roleids</strong>}?first_name={string}&last_name={string}&email={string}&maiden_name={string}&grad_year={string}&end_grad_year={string}&marker={integer}</span>

Please add in the documentation that is it looking for the id of the roles and not the name. I lost an hour trying to figure out why "Student" does not work and returned with the error:

{

errors: [

{

message: 'roles parameter is not in the correct format. Please use a comma delimited string.',

error_code: 400,

error_name: 'ServiceClientException',

raw_message: 'roles parameter is not in the correct format. Please use a comma delimited string.'

}

]

}

Evan York

Hi Tien, sorry to hear that you had a less than ideal experience, we do strive to provide adequate documentation and appreciate your suggestion. However, I would definitely encourage you to review the "Request parameters" section for more detail, whenever possible. Thanks!

Tien Bui

Evan,

I get that part, I was just suggesting that it also say it in the example piece as well.