---
title: "Request Link"
method: POST
path: "/v1/auth/link"
---

# Request Link

`POST /v1/auth/link`

## Request

- Base URL: `https://api.flanner.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.flanner.io/v1/auth/link`
- Auth: none declared

Mail a single-use link to an address.

Always answers the same way, whether or not the address is known.
Saying which addresses have accounts would turn this into a way to
test whether a colleague uses flanner, and it is unauthenticated by
necessity.

## Request body

- RequestSignInLink: Ask for a sign-in link by email.
  - `email` string, required
  - `purpose` string

## Response `200`

Successful Response

- object

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/flanner/apis/flanner-control-plane.md) · [All operations](https://skmtc.dev/flanner/apis/flanner-control-plane/llms.txt) · [OpenAPI document](https://skmtc.dev/flanner/apis/flanner-control-plane/revisions/96c571cfab10?raw)