List awarded students across an award cycle as a flat, cursor-paginated collection (one row per applicant-award). Send award_cycle_id (and any scholarship_id) on every request, including when paging: both are recorded in the cursor and a request whose values do not match the cursor’s is rejected.
List awarded students across an award cycle as a flat, cursor-paginated collection (one row per applicant-award). Send award_cycle_id (and any scholarship_id) on every request, including when paging: both are recorded in the cursor and a request whose values do not match the cursor’s is rejected.
Assistant capability: springiq_get_awarded_students. Required permission: Scholarships (applies when called on behalf of a signed-in person).
Authentication
Query parameters
Page size. Defaults to 25. Values outside 1–100 are clamped rather than rejected.
Opaque cursor. Pass the next_cursor from the previous page to page forward. Mutually exclusive with ending_before; if both are supplied, starting_after wins.
Opaque cursor. Pass the previous_cursor from the current page to page backward.
Optional extras to add to the response, comma-separated. total_count is the only supported value: it adds total_count, the number of records that match this request across all pages. The count is taken fresh at the moment of each request, so it can change while you page; ask for it on the first page. Without it, total_count is left out of the response. Asking or not never invalidates a cursor. Any other value returns 400 validation_failed.
Response
Discriminator constant. Always "list", mirroring Stripe’s list objects.
The request path this collection was served from (e.g. /api/v1/scholarships).
Opaque cursor for the next page (pass as starting_after). Null when there is none.
Opaque cursor for the previous page (pass as ending_before). Null when there is none.
The number of records that match the request across all pages, counted fresh on each
request. Present only when the request includes include=total_count; otherwise the
key is omitted.