Users education BBID status does not return a "next link" field

Brian Gray
Brian Gray Community All-Star
Eighth Anniversary Kudos 5 First Reply bbcon 2025 Attendee Badge
in Education Management APIs

This morning, I found that the BBID status endpoint (V1UsersBbidstatusGet) does not return a next_link field. It does not appear in the data returned to my program and does not appear on the Try It page.

I tested it with base role 14 (current students - fewer than 1000 entries) and 16 (parent of current student - more than 1000 entries). The field does not appear in either call.

Comments

  • Brian Gray
    Brian Gray Community All-Star
    Eighth Anniversary Kudos 5 First Reply bbcon 2025 Attendee Badge

    @Jared Harbour @Tom Sisson - any news on this problem? I still can't get info on all of my users.

  • Jared Harbour
    Jared Harbour Blackbaud Employee
    Eighth Anniversary Kudos 1 Name Dropper Participant

    Hi Brian,

    The next_link functionality wasn't included because we are in the process of bringing the School Api more in line with other APIs under SkyApi and next_link is eventually going away/changing.

    This call works similar to the User Extended API call where the marker is the userId of the last user returned. For example, if your first call had 1000 users and the last user in the list was John Smith (Id: 12345) on the next call you would include the marker parameter and set it to 12345. That will return the next set of users, and you can keep doing that till you get a result set back that is less than 1000.

    We are working on updating the documentation on this route now so there is less confusion going forward. I hope this helps!

    Best,

    Jared

  • Brian Gray
    Brian Gray Community All-Star
    Eighth Anniversary Kudos 5 First Reply bbcon 2025 Attendee Badge

    @Jared Harbour - using the last record's user ID works as described. Thanks.

    My approach this morning is to keep making calls until the count of returned records is 0. Is there any direct indication in the data returned by the call that I have the last page of data? I don't see anything.

  • Jared Harbour
    Jared Harbour Blackbaud Employee
    Eighth Anniversary Kudos 1 Name Dropper Participant

    if you get less than 1000 records you're on the last page. Other than that if you make a call with the marker set to the last user in the list you will get an empty result set with a count of 0 so looking for a count == 0 or count < 1000 will get you the same result.

Categories