Filter Option for Status on Rosters API

Lindsey Bryant · April 8

@Stephen Boyle would it be possible to add an additional filter to the Rosters APIs where a developer can filter on the status? It appears the APIs be default only return “enrolled” students and we need to be able to capture the “dropped” students as well.

Lindsey Bryant · April 18

@Stephen Boyle

Idea Created: API-I-563

Stephen Boyle · October 8

https://community.blackbaud.com/discussion/comment/288222#Comment_288222

@Lindsey Bryant, The roster endpoints (that store a dropped status) were updated. They now include an "Include_dropped" filter option.

Lindsey Bryant · October 13

@Stephen Boyle thanks for the ping. I tried it today and I'm not seeing any dropped students.

I tried the following options and didn't see any differences:

school_year=2025-2026&school_level=XXXX&include_dropped

school_year=2025-2026&school_level=XXXX&include_dropped=true

Am I misunderstanding the way to filter for the students who are dropped in the API: https://developer.sky.blackbaud.com/api#api=school&operation=V1AcademicsRostersGet

Stephen Boyle · October 13

https://community.blackbaud.com/discussion/comment/307742#Comment_307742

Hi Lindsey,

The "include_dropped=true" version is the correct one.
I ran this call through our demo environment and it returned dropped students:

GET https://api.sky.blackbaud.com/school/v1/academics/rosters?school_year=2025-2026&school_level=453&include_dropped=true

Which means it is returning at least some dropped students. That doesn't mean there isn't some case where they are being missed. So, if you have an example of a specific dropped student NOT returned, send that to me (either here or by email) and @Todd DeSchuiteneer and I will get that filed.

Lindsey Bryant · October 13

@Stephen Boyle and @Todd DeSchuiteneer here is an example and probably where the confusion is.

This is a screenshot of a student's schedule for the 2025-2026 school year. You can see that for the fall term, the class as been dropped.

When I pull the roster API and include the filter, the student is showing in the roster API AND so are the rest of the students (who are still registered and taking the class).

I guess I need clarification. The filter will return all students (enrolled and dropped) and if you don't include the filter, you're only going to get those students who are actively enrolled.

Stephen Boyle · October 13

https://community.blackbaud.com/discussion/comment/307750#Comment_307750

Yes, that's correct.

There is a status field in the response indicating "Enrolled" vs "Dropped". If include_dropped is false or omitted, only enrolled students will be in the roster array.

"roster": [{

    "user": {"id": 1, ...},

    "enroll_date": "2024-09-30T01:30:05Z",

    "depart_date": "2024-09-30T01:30:05Z",

    "leader": {"is_leader": true, "is_head": true, ...},

    "photo": { ... },
    "status": "Enrolled",

    "enrollment_type": {"id": 123, "description": "Student Enrollment", ...}

}]

Lindsey Bryant · October 14

Thanks for confirming!

Filter Option for Status on Rosters API

Comments

Categories