List of users

Kathy Miller

I am looking for an API get request that gives me a list of all active users in our Blackbaud account. It seems the only API that allows users is the School API in the link below. None of the requests listed allow you to pull an entire list. The close I have found is the users by role request. The trouble I have with this API is I do not have a list of Role(s) to pull requests from. Could someone point me in the direction to be able to pull a list of users or find a list of Role ids?

Thank you

Bryna Gleich

I think there is a role called “All School.” That might be what you're looking for.

You might also consider

Brian Gray

You can get a list of all roles with a call to Core Roles. The call will return a list of all roles with a name, a role ID, and a base role ID.

Be careful when using the IDs. Some endpoints (such as v1usersget) require the role ID, while others (such as V1UsersExtendedGet) require the base role ID. The parameters list for each endpoint specifies which is required, but you do have to know that there is a difference between the role ID and the base role ID.

Although the role ID and base role ID are both integers, the call to UserGet and UserExtendedGet expect the role ID(s) to be in a string. This allows you to specify more than one role in a single call to the endpoint. Users that have more than one of the specified roles (such as a teacher who is also a parent of a current student) will be included in the list only once.

UserExtendedGet includes a list of the user's roles. All roles assigned to the user will be listed - including roles that were not included in the request.

Brian Gray

@Bryna Gleich is correct. The All School role will return all users in your database, regardless of which other roles are assigned.

The base role ID is 1. You can get the role ID for your school using a call to Core Roles.

Kathy Miller

Bryna,
Thank you for this information. I'm a little unclear on some things and apologize upfront for my very newbie questions. As I don't use Blackbaud from the front end at all, I'm unclear as to how all of the pieces fit into the API calls. I just want to make sure I am asking my questions using the correct verbiage. Our end users only use the financial piece of blackbaud. They log in to approve invoices, etc. They log into the Financial Edge NXT environment. This is the environment that I am trying to determine which users are active. Is this the data that the School API pulls?

Bryna Gleich

Kathy Miller:

Bryna,
Thank you for this information. I'm a little unclear on some things and apologize upfront for my very newbie questions. As I don't use Blackbaud from the front end at all, I'm unclear as to how all of the pieces fit into the API calls. I just want to make sure I am asking my questions using the correct verbiage. Our end users only use the financial piece of blackbaud. They log in to approve invoices, etc. They log into the Financial Edge NXT environment. This is the environment that I am trying to determine which users are active. Is this the data that the School API pulls?

Hi Kathy,

The School API basically corresponds to Blackbaud Education Management, including Core, Academics, Enrollment Management, Extracurricular, School Website, etc.

It doesn't correspond to Financial Edge NXT. I think those are other categories, like General Ledger, Accounts Payable, Statistical Unit, and Treasury. I don't know the Financial Edge side of it personally, but I know there are people in this community who do know it.

and

might be good places to look and ask.

I'll forward this discussion to someone I work with who may know it too.