API Reference

Validate invite token

GET /api/auth/invite/{token}

Validates an invite token and returns the username. Public endpoint.

Operation IDvalidateInvite

Authentication

No authentication is required.

Path parameters

tokenstringrequired

Success response body

200Valid invite token

Valid invite token

Content typeapplication/json

responseobject

3 properties

usernamestring

expires_atstring · date-time

totp_pendingboolean

True when the invite password was accepted and TOTP verification is still pending

Error responses

400Invalid or expired token

Invalid or expired token

No response content schema is documented.

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/auth/invite/YOUR_TOKEN'

const response = await fetch("https://your-envoy.example.com/api/auth/invite/YOUR_TOKEN", {
  method: "GET",
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);