List available-dollars (budget vs. awarded vs. remaining) for every active scholarship in an award cycle. The award_cycle_id is pinned into the cursor, so it is only sent on the first request.

Authentication

X-Spring-API-Keystring
Secret API key issued per institution. Send it on every request.

Query parameters

award_cycle_idintegerOptional
limitintegerOptional1-100Defaults to 25

Page size. Defaults to 25. Values outside 1–100 are clamped rather than rejected.

starting_afterstringOptional

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.

ending_beforestringOptional

Opaque cursor. Pass the previous_cursor from the current page to page backward.

Response

OK
objectstring or nullOptionalRead-only

Discriminator constant. Always "list", mirroring Stripe’s list objects.

urlstring or nullOptional

The request path this collection was served from (e.g. /api/v1/scholarships).

has_morebooleanOptional
True when another page exists in the current paging direction.
next_cursorstring or nullOptional

Opaque cursor for the next page (pass as starting_after). Null when there is none.

previous_cursorstring or nullOptional

Opaque cursor for the previous page (pass as ending_before). Null when there is none.

datalist of objects or nullOptional
The page of items.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error