Skip to navigation
API ReferenceStudents

Get a student.

Fetches one student by their id from the students list. Returns 404 student_not_found, naming id in param, if no such student belongs to this institution.

Assistant capability: springiq_get_student. Required permission: Users (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

idstringRequired

Response

OK
objectstring or nullOptionalRead-only

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.

idstring or nullOptional

The stored ID of the student’s user record. Use it with GET /api/v1/students/{id} and as the user_id filter on the applications and awards lists.

first_namestring or nullOptional
last_namestring or nullOptional
emailstring or nullOptional
student_idstring or nullOptional

The student number the institution assigned (for example an SIS or campus id). Not guaranteed unique — two student accounts can carry the same number — and may be empty when the institution has not recorded one.

enrollment_statusstring or nullOptional

The student’s enrollment standing with the institution: registered (an active student account) or prospective (added ahead of enrollment, e.g. a recruit).

created_dateintegerOptional
When the student account was created, as UTC epoch seconds.

Errors

403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error