SKY API how to pull Parent data

DANIEL SUAREZ
DANIEL SUAREZ
in Education Management APIs

Hi everyone,


New to SKY API, I'm not the person building the API but wanted to see if I could get some help.

We're trying to fetch parent data only with the following information.

  • First Name
  • Last Name
  • External ID (an id to identify individual students/parents)
  • Personal Email

    I did check the link below but don't see a clear way on what endpoints to call.

    Thank you.

Comments

  • Todd DeSchuiteneer
    Todd DeSchuiteneer Blackbaud Employee
    Tenth Anniversary Kudos 2 Name Dropper Participant

    Hi @DANIEL SUAREZ, the endpoint referenced has all the data you are looking for. You would just need to define the parent role in the call. You can get the role ID by calling


    If you are only wanting the fields you mentioned in the post, the best route for this would be build an advanced list via the user interface within the application then call GET List single endpoint:

    If I am misunderstanding the ask, please let me know.

  • Stephen Boyle
    Stephen Boyle Blackbaud Employee
    Tenth Anniversary Kudos 5 Name Dropper Participant

    @DANIEL SUAREZ
    That endpoint will get you a list of users. And you can specify the roles you want to return (e.g. parent, parent of incoming student, etc.). And you can get the role IDs from the Core roles endpoint. You'd end up with something like this “GET https://api.sky.blackbaud.com/school/v1/users?roles=1,2,3,4”

    The data User by role(s) returns does have the data you listed (if the user_id fits for external ID).

    There is also the Users extended by role(s), which returns a ton more data for each user, but is limited to 1000 records at a time (pagination). It uses base roles when filtering, which are also part of the Core roles endpoint.

Categories