/api/v1/invites/{code}/previewNo session neededRead an invite code's household name and inviter before joining
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
code | path | string | Required | — |
Responses
- 200OK
application/jsonInvitePreviewResponse- 404Not Found
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 Requests
application/problem+jsonProblemDetails- Headers
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- Headers
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.
Problem codes
The `code` in the problem body is what to branch on. `detail` is English, written for a log.
invite_not_usable- — That invitation has expired or was already used. Ask for a new one.
Example
curl \
"https://bryti.app/api/v1/invites/string/preview"Example response
application/json{
"householdName": "string",
"inviterFirstName": "string",
"alreadyMember": false
}