Documentation

GET /api/share

The referral link, the people it brought, and the milestones they reached.

RequestGET /api/share
AuthenticationSession cookie required
Handlerbackend/server.py

What it does

The coded link gives attribution; only an observed account plus dashboard milestones qualify a person. A press, a send or an open is never on its own a funded person, and the response reports the ladder rather than a raw click count. People are anonymised.

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

ParameterInTypeRequiredDescription
ff_sessioncookiestringOptionalThe 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/share"
const res = await fetch("https://flowfinds.ai/api/share", {
  method: "GET",
  credentials: "include",
});
const data = await res.json();
import requests

s = requests.Session()
r = s.get("https://flowfinds.ai/api/share")
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  "$FLOWFINDS_ORIGIN/api/share"

Responses

200Always.

FieldTypeDescription
sharedbooleanWhether this session has used the share control.
urlstringThe coded referral link, `/r/<code>` on the share origin.

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

Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.