Documentation · API reference
POST
/api/v1/auth/startContinue (A): a code by email
This page as Markdown, or in an AI chatMore ways to read this page
Continue (A): a code by email. The answer is the same whether or not the address has an account.
# Continue (A): a code by email
> tidekeeper's API reference: https://tidekeeper.eu/docs/api/post-auth-start
`POST /api/v1/auth/start`
Continue (A): a code by email. 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/start \
-H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
-H "Content-Type: application/json" \
-d '{"email": "…"}'
```
What to send
EmailOnly
- 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
curl -X POST https://tidekeeper.eu/api/v1/auth/start \ -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \ -H "Content-Type: application/json" \ -d '{"email": "…"}'
const answer = await fetch("https://tidekeeper.eu/api/v1/auth/start", { method: "POST", headers: { Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`, "Content-Type": "application/json", }, body: JSON.stringify({"email": "…"}), }).then((r) => r.json());