Members

The people at the table — adults, Juniors, babies and guests.4 operations

Headers on every response

Every response on this page carries these headers.
X-Trace-Id
— The W3C trace id of this request — the same id in the log and in the traceId of a problem. Quote it when reporting.
Server-Timing
— Where the time went: total, db;dur=…;desc="N queries", and every step the handler named (ADR-163).
X-Diagnostics
— Only when the request asked with X-Diagnostics: 1 or ?diagnostics=1: the same breakdown as one JSON object, with the trace id (ADR-163).

Operations

GET/api/v1/households/{householdId}/members

List the household's people with today's age and nutrition targets

Guests and inactive people are included. A person is not an account, and may have none.

Parameters

NameInTypeRequiredDescription
householdIdpathstring (uuid)Required—

Responses

200OK
application/jsonHouseholdMemberResponse[]
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
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.

Example

curl -b "bryti_session=…" \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/members"

Example response

200application/json
[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "birthDate": "2026-09-07",
    "ageYears": 0,
    "ageMonths": 0,
    "defaultDinnerParticipant": false,
    "isActive": false,
    "isBreastfed": false,
    "createdAt": "2026-09-07T16:30:00Z",
    "updatedAt": "2026-09-07T16:30:00Z",
    "isGuest": false,
    "isPregnant": false,
    "safetyAdviceOnly": false
  }
]
POST/api/v1/households/{householdId}/members

Add a person to the household — adult, child, baby or usual guest

Adults only; a Junior member gets 403. A person is not an account: link one through Memberships. Without a birthDate the person is planned for as an adult (#599). Adding someone who eats dinner by default resizes every dinner still ahead and marks the shopping list stale (#340). 409 with code consent_required whenever isBreastfed or isPregnant is set: the explicit yes to storing health data is each person's own (GDPR art. 9(2)(a), #2932), and a person not added yet has none — the household's yes does not cover them (#4878). Add the person without it, POST their consent, then set it.

Parameters

NameInTypeRequiredDescription
householdIdpathstring (uuid)Required—

Request body

application/jsonRequiredCreateHouseholdMemberRequest

Responses

201Created
application/jsonHouseholdMemberResponse
400Bad Request
application/problem+jsonProblemDetails
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
404Not Found
application/problem+jsonProblemDetails
409Conflict
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
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.

consent_required
— Bryti needs an explicit yes before it can save health details. You give that yes on the person's card under Household.

Example

curl -b "bryti_session=…" \
  -X POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/members" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","birthDate":"2026-09-07","defaultDinnerParticipant":true,"isBreastfed":false,"isGuest":false}'

Example response

201application/json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "birthDate": "2026-09-07",
  "ageYears": 0,
  "ageMonths": 0,
  "defaultDinnerParticipant": false,
  "isActive": false,
  "isBreastfed": false,
  "createdAt": "2026-09-07T16:30:00Z",
  "updatedAt": "2026-09-07T16:30:00Z",
  "isGuest": false,
  "isPregnant": false,
  "safetyAdviceOnly": false
}
PATCH/api/v1/households/{householdId}/members/{memberId}

Update a person's details, appetite, activity or nutrition overrides

Adults only; a Junior member gets 403. name, birthDate, defaultDinnerParticipant, isActive, isGuest and portionFactor are always applied; isBreastfed, isPregnant and nutritionOverrides are «omit = leave it» (#707). A change in who eats, or how much, resizes every dinner still ahead and marks the shopping list stale (#340). 409 with code consent_required when isBreastfed, isPregnant or nutritionOverrides is set and this person's explicit yes to storing health data is not on file (GDPR art. 9(2)(a), #2932); the refusal names the person in householdMemberId (#4878). Clearing any of them is always allowed.

Parameters

NameInTypeRequiredDescription
householdIdpathstring (uuid)Required—
memberIdpathstring (uuid)Required—

Request body

application/jsonRequiredUpdateHouseholdMemberRequest

Responses

200OK
application/jsonHouseholdMemberResponse
400Bad Request
application/problem+jsonProblemDetails
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
404Not Found
application/problem+jsonProblemDetails
409Conflict
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
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.

consent_required
— Bryti needs an explicit yes before it can save health details. You give that yes on the person's card under Household.

Example

curl -b "bryti_session=…" \
  -X PATCH \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/members/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","birthDate":"2026-09-07","defaultDinnerParticipant":false,"isActive":false,"isGuest":false}'

Example response

200application/json
{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "birthDate": "2026-09-07",
  "ageYears": 0,
  "ageMonths": 0,
  "defaultDinnerParticipant": false,
  "isActive": false,
  "isBreastfed": false,
  "createdAt": "2026-09-07T16:30:00Z",
  "updatedAt": "2026-09-07T16:30:00Z",
  "isGuest": false,
  "isPregnant": false,
  "safetyAdviceOnly": false
}
DELETE/api/v1/households/{householdId}/members/{memberId}

Remove a person from the household

Adults only; a Junior member gets 403. Removing someone who ate dinner by default resizes every dinner still ahead and marks the shopping list stale (#340).

Parameters

NameInTypeRequiredDescription
householdIdpathstring (uuid)Required—
memberIdpathstring (uuid)Required—

Responses

204No Content
401No session, or the session is no longer valid.
application/problem+jsonProblemDetails
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 calls in the window; Retry-After says how long.
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.

Example

curl -b "bryti_session=…" \
  -X DELETE \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/members/3fa85f64-5717-4562-b3fc-2c963f66afa6"

Schemas

CreateHouseholdMemberRequest

PropertyTypeRequired
namestringRequired
birthDatestring (date) | nullRequired
defaultDinnerParticipantboolean—
isBreastfedboolean—
isGuestboolean—
portionFactornumber (double) | null—
isPregnantboolean | null—
safetyAdviceOnlyboolean | null—

HouseholdMemberResponse

PropertyTypeRequired
idstring (uuid)Required
householdIdstring (uuid)Required
namestringRequired
birthDatestring (date) | nullRequired
ageYearsinteger (int32)Required
ageMonthsinteger (int32)Required
defaultDinnerParticipantbooleanRequired
isActivebooleanRequired
isBreastfedbooleanRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
isGuestboolean—
portionFactornumber (double) | null—
nutritionTargetsNutritionTargetsResponse | null—
nutritionOverridesNutritionOverridesDto | null—
isPregnantboolean—
safetyAdviceOnlyboolean—

NutritionOverridesDto

PropertyTypeRequired
energyKcalinteger (int32) | null—
proteinGramsinteger (int32) | null—
fibreGramsinteger (int32) | null—
addedSugarMaxGramsinteger (int32) | null—
saltMaxGramsnumber (double) | null—
fruitVegPortionsinteger (int32) | null—

NutritionTargetsResponse

PropertyTypeRequired
energyKcalinteger (int32)Required
proteinGramsinteger (int32)Required
fibreGramsinteger (int32)Required
addedSugarMaxGramsinteger (int32)Required
saltMaxGramsnumber (double)Required
fruitVegPortionsinteger (int32)Required

ProblemDetails

PropertyTypeRequired
typestring | null—
titlestring | null—
statusinteger (int32) | null—
detailstring | null—
instancestring | null—
codestring | null—

UpdateHouseholdMemberRequest

PropertyTypeRequired
namestringRequired
birthDatestring (date) | nullRequired
defaultDinnerParticipantbooleanRequired
isActivebooleanRequired
isBreastfedboolean | null—
isGuestboolean—
portionFactornumber (double) | null—
nutritionOverridesNutritionOverridesDto | null—
isPregnantboolean | null—
safetyAdviceOnlyboolean | null—