Request password reset

POST

/api/v1/auth/forgot_password

Sends password reset instructions to the email if it exists

Request

Body Params application/jsonRequired

Examples

🟢200OK

application/json

Request processed (always returns success to prevent email enumeration)

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/auth/forgot_password' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "user@example.com"
}'

Response Example

{
    "success": true,
    "data": {
        "message": "If the email exists, password reset instructions have been sent"
    }
}

Modified at 2025-12-03 16:47:21