How do you get a list for all Students and Parents with the School API

John Graser
John Graser
Fourth Anniversary Kudos 1 Facilitator 1 Boomerang (2024)
in Education Management APIs
I'm in the process of replacing an interface to Blackbaud and need to get a list of student and there parents to compare with another system so I can update their info on Blackbuad.


Which School API Endpoint will give me a list of student and there parents on Blackbaud?


Comments

  • Brian Gray
    Brian Gray Community All-Star
    Ninth Anniversary Kudos 5 First Reply bbcon 2025 Attendee Badge
    The User List endpoint can give you a list of users based on role IDs. It's a string of comma-separated IDs.


    If you need more information about each user (such as the relationships), you want User Extended List. It uses a string that is a comma-separated list of BASE role IDs.


    Both endpoints will return chunks of users, so you may need to make subsequent calls that include the marker parameter to get the next chunk.


    You can get the role ID and base role ID for each role through the Role List endpoint.
  • Brian Gray
    Brian Gray Community All-Star
    Ninth Anniversary Kudos 5 First Reply bbcon 2025 Attendee Badge
    If you just need a one-off list of students with all of their parents, you might want to look at the Advanced List template Students with Parents (Flattened): A list of students and four parents listed on same row (flattened).


    You'll find in it Core > Reporting > Manage Lists > Advanced Lists > List Templates. Select the Constituent Information category, and look for the word flat.


    It will give you each student and up to four parents.
  • John Graser
    John Graser
    Fourth Anniversary Kudos 1 Facilitator 1 Boomerang (2024)
    Brian, Thank you, I was putting in the wrong id.

    I have just started using the API.

Categories