Documentation
POST /api/login/request
Request a sign-in link.
| Request | POST /api/login/request |
|---|---|
| Authentication | No authentication |
| Handler | backend/server.py |
What it does
The message is uniform whether or not the address has an account, so the endpoint cannot be used to test for one. `email_sent` reports what was actually observed — separated from what the visitor is told — so the screen can avoid promising an inbox when the mailer is unconfigured.
Authentication
No authentication. The response does not depend on a session.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
email | body | string | Required | The address to send the link to. |
Request
The cookie jar carries the session between calls. Angle-bracketed values are the parameter types from the table above.
curl -s -b cookies.txt -c cookies.txt \
-X POST -H 'Content-Type: application/json' \
-d '{"email":"<string>"}' \
"https://flowfinds.ai/api/login/request"const res = await fetch("https://flowfinds.ai/api/login/request", {
method: "POST",
credentials: "include",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
"email": "<string>"
}),
});
const data = await res.json();import requests
s = requests.Session()
r = s.post("https://flowfinds.ai/api/login/request", json={
"email": "<string>"
})
data = r.json()Recorded example
curl -s -b cookies.txt -c cookies.txt \
-X POST -H 'Content-Type: application/json' \
-d '{"email":"[email protected]"}' \
"$FLOWFINDS_ORIGIN/api/login/request"Responses
200 — Always, for any well-formed address.
| Field | Type | Description |
|---|---|---|
status | string | `link_requested`. |
email_sent | boolean | Whether a message actually left the machine. |
explanation | string | 'If that address has an account…' — uniform by design. |
Errors
| Status | Reason | When |
|---|---|---|
400 | invalid_email | The address is not well formed. |
Related
POST /api/account— Save the account a claim is credited to.POST /api/logout— Sign out.GET /api/settings/business— The business settings the support desk reads.POST /api/settings/business— Save the business settings.GET /api/settings/payout— The payout destination.POST /api/settings/payout— Save the payout destination.POST /api/settings/rules— Manage the support desk's keyword rules.
Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.