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

Name	In	Type	Required	Description
`householdId`	path	`string (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 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 when isBreastfed or isPregnant is set and the household has given no explicit yes to storing health data (GDPR art. 9(2)(a), #2932) — add the person without it, then ask.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (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

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 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); clearing any of them is always allowed.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`memberId`	path	`string (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

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 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

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`memberId`	path	`string (uuid)`	Required	—

Responses

204No Content

401No session, or the session is no longer valid.

application/problem+jsonProblemDetails

404Not Found

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 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

Property	Type	Required
`name`	`string`	Required
`birthDate`	`string (date) \| null`	Required
`defaultDinnerParticipant`	`boolean`	—
`isBreastfed`	`boolean`	—
`isGuest`	`boolean`	—
`portionFactor`	`number (double) \| null`	—
`isPregnant`	`boolean \| null`	—
`safetyAdviceOnly`	`boolean \| null`	—

HouseholdMemberResponse

Property	Type	Required
`id`	`string (uuid)`	Required
`householdId`	`string (uuid)`	Required
`name`	`string`	Required
`birthDate`	`string (date) \| null`	Required
`ageYears`	`integer (int32)`	Required
`ageMonths`	`integer (int32)`	Required
`defaultDinnerParticipant`	`boolean`	Required
`isActive`	`boolean`	Required
`isBreastfed`	`boolean`	Required
`createdAt`	`string (date-time)`	Required
`updatedAt`	`string (date-time)`	Required
`isGuest`	`boolean`	—
`portionFactor`	`number (double) \| null`	—
`nutritionTargets`	`NutritionTargetsResponse \| null`	—
`nutritionOverrides`	`NutritionOverridesDto \| null`	—
`isPregnant`	`boolean`	—
`safetyAdviceOnly`	`boolean`	—

NutritionOverridesDto

Property	Type	Required
`energyKcal`	`integer (int32) \| null`	—
`proteinGrams`	`integer (int32) \| null`	—
`fibreGrams`	`integer (int32) \| null`	—
`addedSugarMaxGrams`	`integer (int32) \| null`	—
`saltMaxGrams`	`number (double) \| null`	—
`fruitVegPortions`	`integer (int32) \| null`	—

NutritionTargetsResponse

Property	Type	Required
`energyKcal`	`integer (int32)`	Required
`proteinGrams`	`integer (int32)`	Required
`fibreGrams`	`integer (int32)`	Required
`addedSugarMaxGrams`	`integer (int32)`	Required
`saltMaxGrams`	`number (double)`	Required
`fruitVegPortions`	`integer (int32)`	Required

ProblemDetails

Property	Type	Required
`type`	`string \| null`	—
`title`	`string \| null`	—
`status`	`integer (int32) \| null`	—
`detail`	`string \| null`	—
`instance`	`string \| null`	—
`code`	`string \| null`	—

UpdateHouseholdMemberRequest

Property	Type	Required
`name`	`string`	Required
`birthDate`	`string (date) \| null`	Required
`defaultDinnerParticipant`	`boolean`	Required
`isActive`	`boolean`	Required
`isBreastfed`	`boolean \| null`	—
`isGuest`	`boolean`	—
`portionFactor`	`number (double) \| null`	—
`nutritionOverrides`	`NutritionOverridesDto \| null`	—
`isPregnant`	`boolean \| null`	—
`safetyAdviceOnly`	`boolean \| null`	—