ApiAuth
Request password reset
POST
Sends password reset link to user email. Rate limited to 3 requests per hour.
X-API-Version?stringAPI version for header-based versioning
Default
"1"Value in
"1""2"application/json- body
email*stringUser email address for password reset
Password reset email sent
response?unknownapplication/jsoncurl -X POST 'http://localhost:3001/api/v1/auth/forgot-password' \ -H 'Content-Type: application/json' \ -d '{ "email": "john.doe@example.com"}'Example Response200
{ "status": "success", "statusCode": 200, "message": "If an account with that email exists, a password reset link has been sent.", "data": null, "meta": { "email_sent_at": "2026-01-31T10:00:00.000Z" }, "timestamp": "2026-01-31T10:00:00.000Z", "path": "/api/v1/auth/forgot-password"}