API ReferenceScholarships

List scholarships.

Returns the scholarships belonging to the institution your API key is issued for, in the list envelope (`object: "list"`, `has_more`, `next_cursor`, `previous_cursor`, `data`). Page forward by passing the returned `next_cursor` as `starting_after`; the last page has `next_cursor: null`. `limit` defaults to 25 and is capped at 100. Results are ordered by scholarship id ascending. Filter with `?q=` (case-insensitive substring match on the scholarship name).

Authentication

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

Query parameters

qstringOptional

Free-text search (?q=). Case-insensitive substring match against the scholarship name. Null/blank means no name filter.

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