Skip to navigation
API ReferenceAwards

List awards.

Returns one page at a time. Each row names the awarded scholarship and its award cycle, and carries the awarded amount and decision date. Without filters the list covers the whole institution; narrow it with user_id (a student’s id from the Students endpoints) to scope to a single student. Returns 404 student_not_found when the user_id does not belong to this institution.

Authentication

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

Query parameters

user_idintegerOptional

Optional student scope (?user_id=): the student’s user record id from the Students endpoints. Omit for a tenant-wide list.

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
404
Not Found Error
429
Too Many Requests Error