CASE FrameworkParticipant API
Endpoints for participant authentication, user management, and study interactions.
Auth
Authentication endpoints
Login with email and password POST
Sign up with email POST
Login using a temporary token (optionally with password or access token) POST
Get info for a temporary token POST
Renew access token POST
Validate access token GET
Revoke refresh tokens for user GET
Resend email verification POST
Verify email by token POST
Logout user (invalidate current session) POST
Request OTP (email by default) GET
Verify OTP code POST
Password
Password endpoints
Events
Study service events endpoints
Enter a study POST
Trigger a custom study event POST
Submit survey response POST
Leave a study POST
Merge temporary participant into user profile POST
Merge a virtual participant into user profile by linking code POST
Register a temporary participant POST
Submit a survey response for a temporary participant POST
Participant data
Endpoints getting participant data in study service
Get assigned surveys for profiles GET
Get a specific survey with context GET
Get participant state GET
Get a linking code by key GET
Get survey responses for a profile GET
Get confidential responses by key GET
Get submission history for profiles GET
Get reports for a profile GET
Get assigned surveys for a temporary participant GET
Get a survey with context for a temporary participant GET
Get virtual participants by linking code GET
List participant files GET
Upload participant file POST
Download participant file GET
Delete participant file DELETE
Studies
Endpoints getting study data in study service
List studies by status GET
Get study by key GET
Check if a code exists in a code list GET
Count available codes in a code list GET
List variables for a study GET
Get a study variable GET
List studies the user participates in GET
User
User endpoints
Get current user GET
Delete current user DELETE
Update the account's preferred language PUT
Add new profile POST
Update profile PUT
Remove a profile POST
Change password POST
Change account email POST
Change phone number POST
Request phone number verification code via SMS GET
Get user attributes GET
Create or update a user attribute POST
Delete a user attribute DELETE
Update contact preferences PUT
Update the user's newsletter and weekly subscription preferences.
Misc
Miscellaneous