Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/eggarcia98/auth-backend/llms.txt

Use this file to discover all available pages before exploring further.

Trigger a password reset email for the specified address. The email contains a link with a reset token. Use that token in the Authorization header when calling Reset password.
For security reasons, this endpoint always returns a success response regardless of whether the email address is registered.

​
Request

POST /api/v1/auth/forgot-password No authentication required.

​
Body

​
email
string
required
The email address of the account to reset the password for. Must be a valid email format.

​
Response

​
success
boolean
required
Indicates whether the request succeeded. Always true on success.
​
data
object

​
Examples

curl --request POST \
  --url https://your-api.com/api/v1/auth/forgot-password \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "user@example.com"
  }'

​
Success response

200
{
  "success": true,
  "data": {
    "message": "Password reset email sent"
  }
}

​
Error responses

400
{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid email address"
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us