Polarity API Docs
Onboarding Routes
Copy Page
Polarity API Docs
Auth Routes
Signup
POST
Login
POST
Get Current User (Protected Routes Access)
GET
Token Expiry Refresh
POST
Logout
POST
Onboarding Routes
Onboarding Status
GET
Update User Onboarding Data Per Step
POST
Onboarding Completed
GET
Reset Onboarding
GET
Onboarding Routes
Copy Page
Onboarding Status
Developing
GET
/onboarding/status
Try it
Run in Apidog
Run in Apidog
1.
Fetches user from db using JWT identity
2.
Returns whether onboarding is complete or not ("onboarding_completed" field of User model) and onboarding step.
3.
Also returns data collected so far
Frontend interaction:
Frontend calls this endpoint to determine what onboarding step user is on, and pre-fill any previously entered data.
Request
Request Example
Shell
JavaScript
Java
Swift
cURL
cURL-Windows
Httpie
wget
PowerShell
curl
--location
--request
GET
'/onboarding/status'
Response
Response Example
{
}
Request
None
Responses
🟢
200
Success
application/json
Generate Code
Body
Generate Code
Modified atÂ
2025-06-20 16:11:15
Previous
Logout
Next
Update User Onboarding Data Per Step