Documentation
GET /api/settings/business
The business settings the support desk reads.
| Request | GET /api/settings/business |
|---|---|
| Authentication | Session cookie required |
| Handler | backend/server.py |
What it does
Business name, the local part of the support address, the canned reply and the mode the AI email agent runs in.
Authentication
Session cookie required. Send the ff_session cookie. Without one the engine treats the caller as a new visitor with no holds and no claims, and returns a new cookie to use from then on.
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
ff_session | cookie | string | Optional | The session identifier. Omit it on the first call and store the value the response sets; every later call must send the same one or the engine treats the caller as a new visitor with no holds and no claims. |
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 \
"https://flowfinds.ai/api/settings/business"const res = await fetch("https://flowfinds.ai/api/settings/business", {
method: "GET",
credentials: "include",
});
const data = await res.json();import requests
s = requests.Session()
r = s.get("https://flowfinds.ai/api/settings/business")
data = r.json()Recorded example
curl -s -b cookies.txt -c cookies.txt \
"$FLOWFINDS_ORIGIN/api/settings/business"Responses
200 — Always.
| Field | Type | Description |
|---|---|---|
status | string | `ok`. |
settings | object | `business_name`, `support_email_local`, `default_canned_subject`, `default_canned_body`, `ai_email_mode`. |
Errors
This endpoint has no failure path of its own. An uncaught exception anywhere in the engine is still returned as structured JSON by the shared guard.
Related
POST /api/account— Save the account a claim is credited to.POST /api/login/request— Request a sign-in link.POST /api/logout— Sign out.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.