This reference documents the external API surface under /api/v1 for the Email Clean application.

Need to run the app first?

Open the Email Clean getting-started guide for local setup, Docker commands, and verification steps.

​
Base URL

Use the same path prefix in every environment:
  • Preferred local API URL via Next.js rewrites: http://localhost:3000/api/v1
  • Direct backend URL for backend-only debugging: http://localhost:3001/api/v1
  • Production API URL: https://email-clean.grorapid.com/api/v1
In local development, Next.js rewrites forward every request from http://localhost:3000/api/v1/* to the backend. That means you should usually call the frontend origin, and the app will route the request to the backend for you. The hosted production app is available at https://email-clean.grorapid.com/.

​
What this reference covers

The API reference is organized by capability:
  • Auth
  • User
  • Email Cleaning
  • System
Protected routes expect a JWT bearer token.

​
Authentication

Protected routes expect a bearer token in the Authorization header: 
Authorization: Bearer <jwt_token>
You can obtain a token by calling POST /api/v1/auth/signin or POST /api/v1/auth/signup.

​
Response envelope

Successful responses share a consistent wrapper: 
{
  "message": "Signed in successfully.",
  "status": true,
  "statusCode": 200,
  "result": {}
}
Error responses follow the same top-level shape: 
{
  "message": "Unauthorized",
  "status": false,
  "statusCode": 401,
  "errors": null
}
Validation failures can also include an errors object keyed by field name.

​
Usage notes

  • Email validation routes are rate limited to 50 requests per 5 minutes for free and pro users.
  • POST /api/v1/email-verify/validate/clean accepts up to 50 email addresses per request.
  • Clean-email usage is subscription limited in the backend: free users can clean 50 emails per month, pro users 10000, and the highest plan bypasses that check.

​
Next step

If you still need to stand up the app locally, follow the Email Clean getting-started guide.