GetUserCurrentStudentInformation

KIP People API (Public)

UpdateUserPreferences

Update a user’s preferences filtered by type

patch

Path Parameters

userIdstring(uuid)required

Body

application/json

idstring(uuid)required

valuebooleanrequired

Response

application/json

The request has succeeded.

datastring(uuid)required

linksarray[object]required

Show Child Parameters

patch/users/{userId}/profile/preferences

Authentication

Client ID

Client Secret

Scopes

KIP.People.Users.Me.Items.Read -

KIP.People.Users.Me.Items.Tickets.Read -

KIP.People.Users.Me.Items.Vouchers.Read -

KIP.People.Users.Me.Items.LoyaltyCards.Read -

KIP.People.Users.Me.Items.Transactions.Read -

KIP.People.Users.Me.Items.SupportTickets.Read -

KIP.People.Users.Me.Profile.Delete -

KIP.People.Users.Me.Profile.Read -

KIP.People.Users.Me.Profile.Basic.Read -

KIP.People.Users.Me.Profile.Write -

KIP.People.Users.Me.Profile.Basic.Write -

KIP.People.Users.Me.Profile.Extended.Read -

KIP.People.Users.Me.Profile.Extended.Write -

KIP.People.Users.Me.Profile.Preferences.Read -

KIP.People.Users.Me.Profile.Preferences.Write -

KIP.People.Users.Me.Profile.Addresses.Read -

KIP.People.Users.Me.Profile.Addresses.Write -

KIP.People.Users.Me.Profile.StudentInformation.Read -

KIP.People.Users.Profile.Write -

KIP.People.Users.Profile.StudentInformation.Write -

KIP.People.Users.Me.Profile.StudentInformation.Write -

KIP.People.Users.Me.Profile.Membership.Write -

KIP.People.Users.Me.Movies.Read -

KIP.People.Users.Me.Movies.History.Read -

KIP.People.Users.Me.Movies.Write -

KIP.People.Users.Me.Movies.History.Write -

KIP.People.Users.Me.Movies.Recommendations.Read -

KIP.People.Users.Me.Movies.Recommendations.Write -

KIP.People.Users.Me.Movies.Wishlist.Read -

KIP.People.Users.Me.Movies.Wishlist.Write -

KIP.People.Users.Me.Exports.Read -

KIP.People.Users.Me.Exports.GDPR.Read -

KIP.People.Companies.Write -

KIP.People.Users.Items.Read -

KIP.People.Users.Items.Tickets.Read -

KIP.People.Users.Items.Vouchers.Read -

KIP.People.Users.Items.LoyaltyCards.Read -

KIP.People.Users.Items.Transactions.Read -

KIP.People.Users.Items.SupportTickets.Read -

KIP.People.Users.Profile.Delete -

KIP.People.Users.Profile.Read -

KIP.People.Users.Profile.Basic.Read -

KIP.People.Users.Profile.Basic.Write -

KIP.People.Users.Profile.Extended.Read -

KIP.People.Users.Profile.Extended.Write -

KIP.People.Users.Profile.Preferences.Read -

KIP.People.Users.Profile.Preferences.Write -

KIP.People.Users.Profile.Addresses.Read -

KIP.People.Users.Profile.Addresses.Write -

KIP.People.Users.Profile.StudentInformation.Read -

KIP.People.Users.Profile.Membership.Write -

KIP.People.Users.Movies.Read -

KIP.People.Users.Movies.History.Read -

KIP.People.Users.Movies.Write -

KIP.People.Users.Movies.History.Write -

KIP.People.Users.Movies.Recommendations.Read -

KIP.People.Users.Movies.Recommendations.Write -

KIP.People.Users.Movies.Wishlist.Read -

KIP.People.Users.Movies.Wishlist.Write -

KIP.People.Users.Exports.GDPR.Read -

KIP.People.Metadata.Read -

KIP.People.Metadata.Preferences.Read -

KIP.People.Metadata.Schools.Read -

KIP.People.Metadata.StudyLevels.Read -

Path Parameters

userId

Query Parameters

Headers

Body

{ "id": "id", "value": false }

application/json

GetUserStudentInformation

Get a user’s student information

get

Path Parameters

userIdstring(uuid)required

Response

application/json

The request has succeeded.

Models.Responses.UserStudentInformationListResponse

The request has succeeded.

dataarray[object]required

Show Child Parameters

metaobject

Show Child Parameters

linksarray[object]required

Show Child Parameters

get/users/{userId}/profile/student-information

Authentication

Client ID

Client Secret

Scopes

KIP.People.Users.Me.Items.Read -

KIP.People.Users.Me.Items.Tickets.Read -

KIP.People.Users.Me.Items.Vouchers.Read -

KIP.People.Users.Me.Items.LoyaltyCards.Read -

KIP.People.Users.Me.Items.Transactions.Read -

KIP.People.Users.Me.Items.SupportTickets.Read -

KIP.People.Users.Me.Profile.Delete -

KIP.People.Users.Me.Profile.Read -

KIP.People.Users.Me.Profile.Basic.Read -

KIP.People.Users.Me.Profile.Write -

KIP.People.Users.Me.Profile.Basic.Write -

KIP.People.Users.Me.Profile.Extended.Read -

KIP.People.Users.Me.Profile.Extended.Write -

KIP.People.Users.Me.Profile.Preferences.Read -

KIP.People.Users.Me.Profile.Preferences.Write -

KIP.People.Users.Me.Profile.Addresses.Read -

KIP.People.Users.Me.Profile.Addresses.Write -

KIP.People.Users.Me.Profile.StudentInformation.Read -

KIP.People.Users.Profile.Write -

KIP.People.Users.Profile.StudentInformation.Write -

KIP.People.Users.Me.Profile.StudentInformation.Write -

KIP.People.Users.Me.Profile.Membership.Write -

KIP.People.Users.Me.Movies.Read -

KIP.People.Users.Me.Movies.History.Read -

KIP.People.Users.Me.Movies.Write -

KIP.People.Users.Me.Movies.History.Write -

KIP.People.Users.Me.Movies.Recommendations.Read -

KIP.People.Users.Me.Movies.Recommendations.Write -

KIP.People.Users.Me.Movies.Wishlist.Read -

KIP.People.Users.Me.Movies.Wishlist.Write -

KIP.People.Users.Me.Exports.Read -

KIP.People.Users.Me.Exports.GDPR.Read -

KIP.People.Companies.Write -

KIP.People.Users.Items.Read -

KIP.People.Users.Items.Tickets.Read -

KIP.People.Users.Items.Vouchers.Read -

KIP.People.Users.Items.LoyaltyCards.Read -

KIP.People.Users.Items.Transactions.Read -

KIP.People.Users.Items.SupportTickets.Read -

KIP.People.Users.Profile.Delete -

KIP.People.Users.Profile.Read -

KIP.People.Users.Profile.Basic.Read -

KIP.People.Users.Profile.Basic.Write -

KIP.People.Users.Profile.Extended.Read -

KIP.People.Users.Profile.Extended.Write -

KIP.People.Users.Profile.Preferences.Read -

KIP.People.Users.Profile.Preferences.Write -

KIP.People.Users.Profile.Addresses.Read -

KIP.People.Users.Profile.Addresses.Write -

KIP.People.Users.Profile.StudentInformation.Read -

KIP.People.Users.Profile.Membership.Write -

KIP.People.Users.Movies.Read -

KIP.People.Users.Movies.History.Read -

KIP.People.Users.Movies.Write -

KIP.People.Users.Movies.History.Write -

KIP.People.Users.Movies.Recommendations.Read -

KIP.People.Users.Movies.Recommendations.Write -

KIP.People.Users.Movies.Wishlist.Read -

KIP.People.Users.Movies.Wishlist.Write -

KIP.People.Users.Exports.GDPR.Read -

KIP.People.Metadata.Read -

KIP.People.Metadata.Preferences.Read -

KIP.People.Metadata.Schools.Read -

KIP.People.Metadata.StudyLevels.Read -

Path Parameters

userId

Query Parameters

Headers

Body

application/json

Get a user’s student information for a academic specified year

get

Path Parameters

userIdstring(uuid)required

yearstring(iso-year)required

Year format (YYYY)

Example:2026

Response

application/json

The request has succeeded.

Models.Responses.UserStudentInformationResponse

The request has succeeded.

dataobjectrequired

Show Child Parameters

linksarray[object]required

Show Child Parameters

get/users/{userId}/profile/student-information/{year}

Authentication

Client ID

Client Secret

Scopes

KIP.People.Users.Me.Items.Read -

KIP.People.Users.Me.Items.Tickets.Read -

KIP.People.Users.Me.Items.Vouchers.Read -

KIP.People.Users.Me.Items.LoyaltyCards.Read -

KIP.People.Users.Me.Items.Transactions.Read -

KIP.People.Users.Me.Items.SupportTickets.Read -

KIP.People.Users.Me.Profile.Delete -

KIP.People.Users.Me.Profile.Read -

KIP.People.Users.Me.Profile.Basic.Read -

KIP.People.Users.Me.Profile.Write -

KIP.People.Users.Me.Profile.Basic.Write -

KIP.People.Users.Me.Profile.Extended.Read -

KIP.People.Users.Me.Profile.Extended.Write -

KIP.People.Users.Me.Profile.Preferences.Read -

KIP.People.Users.Me.Profile.Preferences.Write -

KIP.People.Users.Me.Profile.Addresses.Read -

KIP.People.Users.Me.Profile.Addresses.Write -

KIP.People.Users.Me.Profile.StudentInformation.Read -

KIP.People.Users.Profile.Write -

KIP.People.Users.Profile.StudentInformation.Write -

KIP.People.Users.Me.Profile.StudentInformation.Write -

KIP.People.Users.Me.Profile.Membership.Write -

KIP.People.Users.Me.Movies.Read -

KIP.People.Users.Me.Movies.History.Read -

KIP.People.Users.Me.Movies.Write -

KIP.People.Users.Me.Movies.History.Write -

KIP.People.Users.Me.Movies.Recommendations.Read -

KIP.People.Users.Me.Movies.Recommendations.Write -

KIP.People.Users.Me.Movies.Wishlist.Read -

KIP.People.Users.Me.Movies.Wishlist.Write -

KIP.People.Users.Me.Exports.Read -

KIP.People.Users.Me.Exports.GDPR.Read -

KIP.People.Companies.Write -

KIP.People.Users.Items.Read -

KIP.People.Users.Items.Tickets.Read -

KIP.People.Users.Items.Vouchers.Read -

KIP.People.Users.Items.LoyaltyCards.Read -

KIP.People.Users.Items.Transactions.Read -

KIP.People.Users.Items.SupportTickets.Read -

KIP.People.Users.Profile.Delete -

KIP.People.Users.Profile.Read -

KIP.People.Users.Profile.Basic.Read -

KIP.People.Users.Profile.Basic.Write -

KIP.People.Users.Profile.Extended.Read -

KIP.People.Users.Profile.Extended.Write -

KIP.People.Users.Profile.Preferences.Read -

KIP.People.Users.Profile.Preferences.Write -

KIP.People.Users.Profile.Addresses.Read -

KIP.People.Users.Profile.Addresses.Write -

KIP.People.Users.Profile.StudentInformation.Read -

KIP.People.Users.Profile.Membership.Write -

KIP.People.Users.Movies.Read -

KIP.People.Users.Movies.History.Read -

KIP.People.Users.Movies.Write -

KIP.People.Users.Movies.History.Write -

KIP.People.Users.Movies.Recommendations.Read -

KIP.People.Users.Movies.Recommendations.Write -

KIP.People.Users.Movies.Wishlist.Read -

KIP.People.Users.Movies.Wishlist.Write -

KIP.People.Users.Exports.GDPR.Read -

KIP.People.Metadata.Read -

KIP.People.Metadata.Preferences.Read -

KIP.People.Metadata.Schools.Read -

KIP.People.Metadata.StudyLevels.Read -

Path Parameters

userId

year

Query Parameters

Headers

Body

application/json

AddUserCurrentStudentInformation

Add a user’s student information for a specific academic year

post

Path Parameters

userIdstring(uuid)required

yearstring(iso-year)required

Year format (YYYY)

Example:2026

Body

application/json

Models.StudentInformation

schoolIdstringrequired

The unique identifier of the school the student is enrolled in. Can be obtained from the /metadata/users/school-options endpoint.

studyLevelstringrequired

The study level of the student. Can be obtained from the /metadata/users/study-level-options endpoint.

academicYearstringrequired

The academic year of the student.

lastYearbooleanrequired

Indicates if the student is in their last year.

Response

application/json

The request has succeeded.

datastring(uuid)required

linksarray[object]required

Show Child Parameters

post/users/{userId}/profile/student-information/{year}

Authentication

Client ID

Client Secret

Scopes

KIP.People.Users.Me.Items.Read -

KIP.People.Users.Me.Items.Tickets.Read -

KIP.People.Users.Me.Items.Vouchers.Read -

KIP.People.Users.Me.Items.LoyaltyCards.Read -

KIP.People.Users.Me.Items.Transactions.Read -

KIP.People.Users.Me.Items.SupportTickets.Read -

KIP.People.Users.Me.Profile.Delete -

KIP.People.Users.Me.Profile.Read -

KIP.People.Users.Me.Profile.Basic.Read -

KIP.People.Users.Me.Profile.Write -

KIP.People.Users.Me.Profile.Basic.Write -

KIP.People.Users.Me.Profile.Extended.Read -

KIP.People.Users.Me.Profile.Extended.Write -

KIP.People.Users.Me.Profile.Preferences.Read -

KIP.People.Users.Me.Profile.Preferences.Write -

KIP.People.Users.Me.Profile.Addresses.Read -

KIP.People.Users.Me.Profile.Addresses.Write -

KIP.People.Users.Me.Profile.StudentInformation.Read -

KIP.People.Users.Profile.Write -

KIP.People.Users.Profile.StudentInformation.Write -

KIP.People.Users.Me.Profile.StudentInformation.Write -

KIP.People.Users.Me.Profile.Membership.Write -

KIP.People.Users.Me.Movies.Read -

KIP.People.Users.Me.Movies.History.Read -

KIP.People.Users.Me.Movies.Write -

KIP.People.Users.Me.Movies.History.Write -

KIP.People.Users.Me.Movies.Recommendations.Read -

KIP.People.Users.Me.Movies.Recommendations.Write -

KIP.People.Users.Me.Movies.Wishlist.Read -

KIP.People.Users.Me.Movies.Wishlist.Write -

KIP.People.Users.Me.Exports.Read -

KIP.People.Users.Me.Exports.GDPR.Read -

KIP.People.Companies.Write -

KIP.People.Users.Items.Read -

KIP.People.Users.Items.Tickets.Read -

KIP.People.Users.Items.Vouchers.Read -

KIP.People.Users.Items.LoyaltyCards.Read -

KIP.People.Users.Items.Transactions.Read -

KIP.People.Users.Items.SupportTickets.Read -

KIP.People.Users.Profile.Delete -

KIP.People.Users.Profile.Read -

KIP.People.Users.Profile.Basic.Read -

KIP.People.Users.Profile.Basic.Write -

KIP.People.Users.Profile.Extended.Read -

KIP.People.Users.Profile.Extended.Write -

KIP.People.Users.Profile.Preferences.Read -

KIP.People.Users.Profile.Preferences.Write -

KIP.People.Users.Profile.Addresses.Read -

KIP.People.Users.Profile.Addresses.Write -

KIP.People.Users.Profile.StudentInformation.Read -

KIP.People.Users.Profile.Membership.Write -

KIP.People.Users.Movies.Read -

KIP.People.Users.Movies.History.Read -

KIP.People.Users.Movies.Write -

KIP.People.Users.Movies.History.Write -

KIP.People.Users.Movies.Recommendations.Read -

KIP.People.Users.Movies.Recommendations.Write -

KIP.People.Users.Movies.Wishlist.Read -

KIP.People.Users.Movies.Wishlist.Write -

KIP.People.Users.Exports.GDPR.Read -

KIP.People.Metadata.Read -

KIP.People.Metadata.Preferences.Read -

KIP.People.Metadata.Schools.Read -

KIP.People.Metadata.StudyLevels.Read -

Path Parameters

userId

year

Query Parameters

Headers

Body

Show only required parameters

{ "schoolId": "schoolId", "studyLevel": "studyLevel", "academicYear": "academicYear", "lastYear": false }

application/json

UpdateUserCurrentStudentInformation

Update a user’s student information for a specific academic year

put

Path Parameters

userIdstring(uuid)required

yearstring(iso-year)required

Year format (YYYY)

Example:2026

Body

application/json

Models.StudentInformation

schoolIdstringrequired

The unique identifier of the school the student is enrolled in. Can be obtained from the /metadata/users/school-options endpoint.

studyLevelstringrequired

The study level of the student. Can be obtained from the /metadata/users/study-level-options endpoint.

academicYearstringrequired

The academic year of the student.

lastYearbooleanrequired

Indicates if the student is in their last year.

Response

The request has succeeded.

put/users/{userId}/profile/student-information/{year}

Authentication

Client ID

Client Secret

Scopes

KIP.People.Users.Me.Items.Read -

KIP.People.Users.Me.Items.Tickets.Read -

KIP.People.Users.Me.Items.Vouchers.Read -

KIP.People.Users.Me.Items.LoyaltyCards.Read -

KIP.People.Users.Me.Items.Transactions.Read -

KIP.People.Users.Me.Items.SupportTickets.Read -

KIP.People.Users.Me.Profile.Delete -

KIP.People.Users.Me.Profile.Read -

KIP.People.Users.Me.Profile.Basic.Read -

KIP.People.Users.Me.Profile.Write -

KIP.People.Users.Me.Profile.Basic.Write -

KIP.People.Users.Me.Profile.Extended.Read -

KIP.People.Users.Me.Profile.Extended.Write -

KIP.People.Users.Me.Profile.Preferences.Read -

KIP.People.Users.Me.Profile.Preferences.Write -

KIP.People.Users.Me.Profile.Addresses.Read -

KIP.People.Users.Me.Profile.Addresses.Write -

KIP.People.Users.Me.Profile.StudentInformation.Read -

KIP.People.Users.Profile.Write -

KIP.People.Users.Profile.StudentInformation.Write -

KIP.People.Users.Me.Profile.StudentInformation.Write -

KIP.People.Users.Me.Profile.Membership.Write -

KIP.People.Users.Me.Movies.Read -

KIP.People.Users.Me.Movies.History.Read -

KIP.People.Users.Me.Movies.Write -

KIP.People.Users.Me.Movies.History.Write -

KIP.People.Users.Me.Movies.Recommendations.Read -

KIP.People.Users.Me.Movies.Recommendations.Write -

KIP.People.Users.Me.Movies.Wishlist.Read -

KIP.People.Users.Me.Movies.Wishlist.Write -

KIP.People.Users.Me.Exports.Read -

KIP.People.Users.Me.Exports.GDPR.Read -

KIP.People.Companies.Write -

KIP.People.Users.Items.Read -

KIP.People.Users.Items.Tickets.Read -

KIP.People.Users.Items.Vouchers.Read -

KIP.People.Users.Items.LoyaltyCards.Read -

KIP.People.Users.Items.Transactions.Read -

KIP.People.Users.Items.SupportTickets.Read -

KIP.People.Users.Profile.Delete -

KIP.People.Users.Profile.Read -

KIP.People.Users.Profile.Basic.Read -

KIP.People.Users.Profile.Basic.Write -

KIP.People.Users.Profile.Extended.Read -

KIP.People.Users.Profile.Extended.Write -

KIP.People.Users.Profile.Preferences.Read -

KIP.People.Users.Profile.Preferences.Write -

KIP.People.Users.Profile.Addresses.Read -

KIP.People.Users.Profile.Addresses.Write -

KIP.People.Users.Profile.StudentInformation.Read -

KIP.People.Users.Profile.Membership.Write -

KIP.People.Users.Movies.Read -

KIP.People.Users.Movies.History.Read -

KIP.People.Users.Movies.Write -

KIP.People.Users.Movies.History.Write -

KIP.People.Users.Movies.Recommendations.Read -

KIP.People.Users.Movies.Recommendations.Write -

KIP.People.Users.Movies.Wishlist.Read -

KIP.People.Users.Movies.Wishlist.Write -

KIP.People.Users.Exports.GDPR.Read -

KIP.People.Metadata.Read -

KIP.People.Metadata.Preferences.Read -

KIP.People.Metadata.Schools.Read -

KIP.People.Metadata.StudyLevels.Read -

Path Parameters

userId

year

Query Parameters

Headers

Body

Show only required parameters

{ "schoolId": "schoolId", "studyLevel": "studyLevel", "academicYear": "academicYear", "lastYear": false }