GET
/api/v1/households/{householdId}/referral-codesList the referral codes the household's members may hand out
Any member. Minted lazily up to the configured count, single-use, tied to the household. A household on a free plan gets an empty list — referral is a perk of paying.
Parametre
| Navn | Hvor | Type | Påkrevd | Beskrivelse |
|---|---|---|---|---|
householdId | path | string (uuid) | Påkrevd | — |
Svar
- 200OK
application/jsonReferralCodeResponse[]- 401No session, or the session is no longer valid.
application/problem+jsonProblemDetails- 426The build named in X-App-Version is below its platform's version floor (ADR-070). Problem type app-version-unsupported; the only way forward is the store. Callers without the header are never turned away.
application/problem+jsonProblemDetails- 429Too many calls in the window; Retry-After says how long.
application/problem+jsonProblemDetails- Hoder
Retry-After- — Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
- 503The server is down for maintenance (#4693). Retry-After says when to try again; problem type maintenance. Every call under /api answers this while maintenance mode is on, the version floor included.
application/problem+jsonProblemDetails- Hoder
Retry-After- — Seconds to wait when a rate limit answered or the server is down for maintenance, or an HTTP date when the household's AI is paused. Absent when the household's AI quota for the period is used up — that resets by itself.
Eksempel
curl -b "bryti_session=…" \
"https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/referral-codes"Eksempel på svar
200
application/json[
{
"code": "string",
"maxUses": 0,
"uses": 0,
"expiresAt": "2026-09-07T16:30:00Z"
}
]