Email a link to choose a new password

This page as Markdown, or in an AI chatMore ways to read this page

Email a link to choose a new password. The answer is the same whether or not the address has an account.

# Email a link to choose a new password

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/post-auth-reset

`POST /api/v1/auth/reset`

Email a link to choose a new password. The answer is the same whether or not the address has an account.

## What to send

`EmailOnly`

- `email` (string, needed)

## The answer

202, `Sent`: The same answer whoever asked and whatever was found: a page that sends a link cannot be used to learn who has an account.

- `again_in` (integer, needed): How long before another can be asked for, in seconds.
- `minutes` (integer, needed): How long the link works, in minutes.
- `sent` (boolean, needed)

## Asking

```sh
curl -X POST https://tidekeeper.eu/api/v1/auth/reset \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"email": "…"}'
```

What to send

EmailOnly

email: stringneeded

The answer

Status 202

Sent The same answer whoever asked and whatever was found: a page that sends a link cannot be used to learn who has an account.

again_in: integerneededHow long before another can be asked for, in seconds.
minutes: integerneededHow long the link works, in minutes.
sent: booleanneeded

Asking

curlJavaScript

With your token from Settings

curl -X POST https://tidekeeper.eu/api/v1/auth/reset \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"email": "…"}'

With your token from Settings

const answer = await fetch("https://tidekeeper.eu/api/v1/auth/reset", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"email": "…"}),
}).then((r) => r.json());