Available-dollars (budget vs. awarded vs. remaining) for a single scholarship within an award cycle. A scholarship ID the institution does not have returns 404 scholarship_not_found naming scholarshipId.
Available-dollars (budget vs. awarded vs. remaining) for a single scholarship within an award cycle. A scholarship ID the institution does not have returns 404 scholarship_not_found naming scholarshipId.
Assistant capability: springiq_get_available_scholarship_dollars. Required permission: Scholarships (applies when called on behalf of a signed-in person).
Authentication
X-Spring-API-Keystring
Secret API key issued per institution. Send it on every request.
Path parameters
scholarshipId
Query parameters
award_cycle_id
Response
OK
object
Stripe-style resource discriminator. Stable, snake_case string naming the resource type. Serialized first so it reads as the leading field of every V1 resource body.
id
The scholarship's stored ID.
name
total_funds
total_awarded_amount
total_amount_remaining
Errors
400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error