Privacy

Export the household's data, or delete it.8 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

DELETE/api/v1/me

Delete the caller's account and sign out

Any signed-in user (GDPR art. 17). Households nobody else uses go with it; shared ones lose this member. Also removes the caller's invites, waitlist entry and problem reports with their screenshots, then signs the session out. 400 while the caller owns a household others still use — make someone else an owner, or remove the others, first.

Parameters

No parameters

Responses

204No Content

400Bad Request

application/problem+jsonProblemDetails

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=…" \
  -X DELETE \
  "https://bryti.app/api/v1/me"

DELETE/api/v1/households/{householdId}

Delete the household and everything it owns

Owner only. 400 with the reason while other people still use it — hand ownership over and leave, or remove them — or while a subscription is still linked (cancel it in the portal first). Every household-owned table goes with the household row (#299).

Parameters

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

Responses

204No Content

400Bad Request

application/problem+jsonProblemDetails

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"

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

Export everything the household has put into Bryti as one document

Any member (GDPR art. 20). Derived data the app can rebuild — candidate pools, price caches — and internal costs are left out. Personal to the caller: only their own conversations and push devices are included, and co-members appear by name and role only (#984, ADR-084).

Parameters

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

Responses

200OK

application/jsonDataExportResponse

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=…" \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/export"

Example response

200application/json

{
  "exportedAt": "2026-09-07T16:30:00Z",
  "account": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "email": "string",
    "displayName": "string"
  },
  "household": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "timeZoneId": "string",
    "defaultDinnerTime": "string",
    "preferredLanguage": "string",
    "country": "string",
    "address": "string",
    "loyaltyPrograms": [
      "string"
    ],
    "createdAt": "2026-09-07T16:30:00Z"
  },
  "people": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "birthDate": "2026-09-07",
      "isActive": false,
      "eatsDinnerAtHome": false,
      "isBreastfed": false,
      "isPregnant": false
    }
  ],
  "access": [
    {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "displayName": "string",
      "role": "string"
    }
  ],
  "allergies": [
    {
      "description": "string",
      "createdAt": "2026-09-07T16:30:00Z"
    }
  ],
  "tastes": [
    {
      "description": "string",
      "createdAt": "2026-09-07T16:30:00Z"
    }
  ],
  "rules": [
    {
      "description": "string",
      "createdAt": "2026-09-07T16:30:00Z"
    }
  ],
  "events": [
    {
      "date": "2026-09-07",
      "endDate": "2026-09-07",
      "kind": "string",
      "note": "string",
      "guestAdults": 0,
      "guestChildren": 0,
      "guestAvoids": [
        "string"
      ]
    }
  ],
  "calendars": [
    {
      "description": "string",
      "createdAt": "2026-09-07T16:30:00Z"
    }
  ],
  "recipes": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "category": "string",
      "source": "string",
      "activeMinutes": 0,
      "totalMinutes": 0,
      "basePortions": 0,
      "tags": [
        "string"
      ],
      "ingredients": [
        "string"
      ],
      "steps": [
        "string"
      ],
      "isBase": false
    }
  ],
  "favourites": [
    {
      "description": "string",
      "createdAt": "2026-09-07T16:30:00Z"
    }
  ],
  "exclusions": [
    {
      "description": "string",
      "createdAt": "2026-09-07T16:30:00Z"
    }
  ],
  "wishes": [
    {
      "description": "string",
      "createdAt": "2026-09-07T16:30:00Z"
    }
  ],
  "plans": [
    {
      "weekStart": "2026-09-07",
      "status": "string",
      "days": [
        {}
      ]
    }
  ],
  "inventory": [
    {
      "foodKey": "string",
      "displayName": "string",
      "quantity": 0,
      "unit": "string",
      "storageLocation": "string",
      "observationType": "string",
      "observedAt": "2026-09-07T16:30:00Z"
    }
  ],
  "shoppingLists": [
    {
      "weekStart": "2026-09-07",
      "createdAt": "2026-09-07T16:30:00Z",
      "items": [
        {}
      ]
    }
  ],
  "stores": [
    {
      "description": "string",
      "createdAt": "2026-09-07T16:30:00Z"
    }
  ],
  "productChoices": [
    {
      "foodKey": "string",
      "displayName": "string",
      "chainCode": "string",
      "productName": "string",
      "chosenAt": "2026-09-07T16:30:00Z"
    }
  ],
  "conversations": [
    {
      "createdAt": "2026-09-07T16:30:00Z",
      "title": "string",
      "messages": [
        {}
      ]
    }
  ],
  "outcomes": [
    {
      "date": "2026-09-07",
      "status": "string",
      "note": "string"
    }
  ],
  "imports": [
    {
      "kind": "string",
      "status": "string",
      "source": "string",
      "createdAt": "2026-09-07T16:30:00Z"
    }
  ],
  "priceObservations": [
    {
      "foodKey": "string",
      "productName": "string",
      "rawText": "string",
      "store": "string",
      "location": "string",
      "linePrice": 0,
      "unitPrice": 0,
      "unitPriceUnit": "string",
      "latitude": 0,
      "longitude": 0,
      "observedAt": "2026-09-07T16:30:00Z"
    }
  ],
  "subscription": {
    "planCode": "string",
    "planName": "string",
    "periodStartsAt": "2026-09-07T16:30:00Z",
    "periodEndsAt": "2026-09-07T16:30:00Z",
    "creditsUsed": 0,
    "creditLimit": 0
  },
  "devices": [
    {
      "platform": "string",
      "provider": "string",
      "tokenSuffix": "string",
      "listChanges": false,
      "householdNews": false,
      "runDone": false,
      "registeredAt": "2026-09-07T16:30:00Z",
      "lastSeenAt": "2026-09-07T16:30:00Z"
    }
  ],
  "consents": [
    {
      "kind": "string",
      "who": "string",
      "givenBy": "string",
      "textVersion": "string",
      "givenAt": "2026-09-07T16:30:00Z",
      "withdrawnAt": "2026-09-07T16:30:00Z"
    }
  ]
}

GET/api/v1/households/{householdId}/deletion-preview

See what deleting the household would take with it, and whether it is allowed

Owner only. CanDelete is false with BlockerCode other_members while another login still belongs, or billing_subscription while a Stripe subscription is linked (#299).

Parameters

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

Responses

200OK

application/jsonDeleteHouseholdPreviewResponse

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=…" \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/deletion-preview"

Example response

200application/json

{
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "otherMembers": 0,
  "hasBillingSubscription": false,
  "canDelete": false,
  "blockerCode": "string"
}

GET/api/v1/me/deletion-preview

See what deleting the account would do to each of the caller's households

Any signed-in user. A household nobody else uses is deleted with the account; a shared one just loses this member. CanDelete is false, with BlockerCode sole_owner_with_members, while the caller owns a household others still use. Blocker is the same thing in an English sentence, for a log — a screen says it from the code and Households (#2362).

Parameters

No parameters

Responses

200OK

application/jsonDeleteAccountPreviewResponse

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

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/me/deletion-preview"

Example response

200application/json

{
  "households": [
    {
      "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "role": "string",
      "otherMembers": 0,
      "willBeDeleted": false
    }
  ],
  "canDelete": false,
  "blocker": "string"
}

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

List the household's explicit yesses, given and withdrawn

Any member. Withdrawn rows stay in the list with the moment they were taken back: the register answers «what was agreed, to which words, and until when» (GDPR art. 7(1)). householdMemberId null means the consent covers everyone at the table.

Parameters

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

Responses

200OK

application/jsonConsentResponse[]

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

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/consents"

Example response

200application/json

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "householdMemberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "kind": "HealthData",
    "textVersion": "string",
    "givenAt": "2026-09-07T16:30:00Z",
    "withdrawnAt": "2026-09-07T16:30:00Z"
  }
]

POST/api/v1/households/{householdId}/consents

Record an explicit yes to storing health data about one person

Adults only; a Junior member gets 403 — a child cannot consent for themselves, and the adult who presses it consents for a child in their care (art. 8). textVersion is the version of the text that was on the screen, so the stored yes can always be read back as the words the person saw; the register of versions is docs/GDPR.md §10. Giving a yes that already stands returns the standing one rather than a second row.

Parameters

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

Request body

application/jsonRequiredGiveConsentRequest

Responses

201Created

application/jsonConsentResponse

400Bad Request

application/problem+jsonProblemDetails

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 POST \
  "https://bryti.app/api/v1/households/3fa85f64-5717-4562-b3fc-2c963f66afa6/consents" \
  -H "Content-Type: application/json" \
  -d '{"kind":"HealthData","textVersion":"string"}'

Example response

201application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "householdMemberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "kind": "HealthData",
  "textVersion": "string",
  "givenAt": "2026-09-07T16:30:00Z",
  "withdrawnAt": "2026-09-07T16:30:00Z"
}

DELETE/api/v1/households/{householdId}/consents/{consentId}

Take a yes back and clear the health data it allowed

Adults only; a Junior member gets 403. The row is kept and stamped withdrawn — deleting it would say the yes never happened — and in the same transaction the allergies, intolerances and diets recorded for the subject are deleted and the person's breastfeeding, pregnancy and hand-set nutrition targets go back to «nothing said» (art. 7(3)). A consent that is already withdrawn answers 204 and clears nothing again.

Parameters

Name	In	Type	Required	Description
`householdId`	path	`string (uuid)`	Required	—
`consentId`	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/consents/3fa85f64-5717-4562-b3fc-2c963f66afa6"

Schemas

ConsentKind

Type

Values

HealthData

ConsentResponse

Property	Type	Required
`id`	`string (uuid)`	Required
`householdId`	`string (uuid)`	Required
`householdMemberId`	`string (uuid) \| null`	Required
`kind`	`ConsentKind`	Required
`textVersion`	`string`	Required
`givenAt`	`string (date-time)`	Required
`withdrawnAt`	`string (date-time) \| null`	Required

DataExportResponse

Property	Type	Required
`exportedAt`	`string (date-time)`	Required
`account`	`ExportAccount`	Required
`household`	`ExportHousehold`	Required
`people`	`ExportPerson[]`	Required
`access`	`ExportAccess[]`	Required
`allergies`	`ExportNamed[]`	Required
`tastes`	`ExportNamed[]`	Required
`rules`	`ExportNamed[]`	Required
`events`	`ExportEvent[]`	Required
`calendars`	`ExportNamed[]`	Required
`recipes`	`ExportRecipe[]`	Required
`favourites`	`ExportNamed[]`	Required
`exclusions`	`ExportNamed[]`	Required
`wishes`	`ExportNamed[]`	Required
`plans`	`ExportPlan[]`	Required
`inventory`	`ExportInventoryItem[]`	Required
`shoppingLists`	`ExportShoppingList[]`	Required
`stores`	`ExportNamed[]`	Required
`productChoices`	`ExportProductChoice[]`	Required
`conversations`	`ExportConversation[]`	Required
`outcomes`	`ExportOutcome[]`	Required
`imports`	`ExportImport[]`	Required
`priceObservations`	`ExportPriceObservation[]`	Required
`subscription`	`ExportSubscription`	Required
`devices`	`ExportDevice[]`	Required
`consents`	`ExportConsent[]`	Required

DeleteAccountPreviewResponse

Property	Type	Required
`households`	`DeleteHouseholdImpact[]`	Required
`canDelete`	`boolean`	Required
`blocker`	`string \| null`	Required
`blockerCode`	`string \| null`	—

DeleteHouseholdImpact

Property	Type	Required
`householdId`	`string (uuid)`	Required
`name`	`string`	Required
`role`	`string`	Required
`otherMembers`	`integer (int32)`	Required
`willBeDeleted`	`boolean`	Required

DeleteHouseholdPreviewResponse

Property	Type	Required
`householdId`	`string (uuid)`	Required
`name`	`string`	Required
`otherMembers`	`integer (int32)`	Required
`hasBillingSubscription`	`boolean`	Required
`canDelete`	`boolean`	Required
`blockerCode`	`string \| null`	Required

ExportAccess

Property	Type	Required
`userId`	`string (uuid) \| null`	Required
`displayName`	`string`	Required
`role`	`string`	Required

ExportAccount

Property	Type	Required
`id`	`string (uuid)`	Required
`email`	`string \| null`	Required
`displayName`	`string`	Required

ExportConsent

Property	Type	Required
`kind`	`string`	Required
`who`	`string`	Required
`givenBy`	`string`	Required
`textVersion`	`string`	Required
`givenAt`	`string (date-time)`	Required
`withdrawnAt`	`string (date-time) \| null`	Required

ExportConversation

Property	Type	Required
`createdAt`	`string (date-time)`	Required
`title`	`string \| null`	Required
`messages`	`ExportMessage[]`	Required

ExportDevice

Property	Type	Required
`platform`	`string`	Required
`provider`	`string`	Required
`tokenSuffix`	`string`	Required
`listChanges`	`boolean`	Required
`householdNews`	`boolean`	Required
`runDone`	`boolean`	Required
`registeredAt`	`string (date-time)`	Required
`lastSeenAt`	`string (date-time)`	Required

ExportEvent

Property	Type	Required
`date`	`string (date)`	Required
`endDate`	`string (date) \| null`	Required
`kind`	`string`	Required
`note`	`string \| null`	Required
`guestAdults`	`integer (int32)`	Required
`guestChildren`	`integer (int32)`	Required
`guestAvoids`	`string[]`	Required

ExportHousehold

Property	Type	Required
`id`	`string (uuid)`	Required
`name`	`string`	Required
`timeZoneId`	`string`	Required
`defaultDinnerTime`	`string`	Required
`preferredLanguage`	`string`	Required
`country`	`string`	Required
`address`	`string \| null`	Required
`loyaltyPrograms`	`string[]`	Required
`createdAt`	`string (date-time)`	Required

ExportImport

Property	Type	Required
`kind`	`string`	Required
`status`	`string`	Required
`source`	`string \| null`	Required
`createdAt`	`string (date-time)`	Required

ExportInventoryItem

Property	Type	Required
`foodKey`	`string`	Required
`displayName`	`string`	Required
`quantity`	`number (double)`	Required
`unit`	`string \| null`	Required
`storageLocation`	`string`	Required
`observationType`	`string`	Required
`observedAt`	`string (date-time)`	Required

ExportMessage

Property	Type	Required
`role`	`string`	Required
`content`	`string`	Required
`createdAt`	`string (date-time)`	Required

ExportNamed

Property	Type	Required
`description`	`string`	Required
`createdAt`	`string (date-time) \| null`	Required

ExportOutcome

Property	Type	Required
`date`	`string (date)`	Required
`status`	`string`	Required
`note`	`string \| null`	Required

ExportPerson

Property	Type	Required
`id`	`string (uuid)`	Required
`name`	`string`	Required
`birthDate`	`string (date) \| null`	Required
`isActive`	`boolean`	Required
`eatsDinnerAtHome`	`boolean`	Required
`isBreastfed`	`boolean`	—
`isPregnant`	`boolean`	—

ExportPlan

Property	Type	Required
`weekStart`	`string (date)`	Required
`status`	`string`	Required
`days`	`ExportPlanDay[]`	Required

ExportPlanDay

Property	Type	Required
`date`	`string (date)`	Required
`kind`	`string`	Required
`title`	`string \| null`	Required
`locked`	`boolean`	Required

ExportPriceObservation

Property	Type	Required
`foodKey`	`string`	Required
`productName`	`string`	Required
`rawText`	`string \| null`	Required
`store`	`string \| null`	Required
`location`	`string \| null`	Required
`linePrice`	`number (double)`	Required
`unitPrice`	`number (double) \| null`	Required
`unitPriceUnit`	`string \| null`	Required
`latitude`	`number (double) \| null`	Required
`longitude`	`number (double) \| null`	Required
`observedAt`	`string (date-time)`	Required

ExportProductChoice

Property	Type	Required
`foodKey`	`string`	Required
`displayName`	`string`	Required
`chainCode`	`string`	Required
`productName`	`string`	Required
`chosenAt`	`string (date-time)`	Required

ExportRecipe

Property	Type	Required
`id`	`string (uuid)`	Required
`title`	`string`	Required
`category`	`string`	Required
`source`	`string`	Required
`activeMinutes`	`integer (int32)`	Required
`totalMinutes`	`integer (int32)`	Required
`basePortions`	`integer (int32)`	Required
`tags`	`string[]`	Required
`ingredients`	`string[]`	Required
`steps`	`string[]`	Required
`sourceUrl`	`string \| null`	—
`isBase`	`boolean`	—
`sections`	`string[] \| null`	—
`references`	`string[] \| null`	—
`photo`	`string \| null`	—

ExportShoppingItem

Property	Type	Required
`displayName`	`string`	Required
`quantity`	`number (double) \| null`	Required
`unit`	`string \| null`	Required
`status`	`string`	Required
`purchased`	`boolean`	Required

ExportShoppingList

Property	Type	Required
`weekStart`	`string (date)`	Required
`createdAt`	`string (date-time)`	Required
`items`	`ExportShoppingItem[]`	Required

ExportSubscription

Property	Type	Required
`planCode`	`string`	Required
`planName`	`string`	Required
`periodStartsAt`	`string (date-time) \| null`	Required
`periodEndsAt`	`string (date-time) \| null`	Required
`creditsUsed`	`integer (int32)`	Required
`creditLimit`	`integer (int32)`	Required

GiveConsentRequest

Property	Type	Required
`kind`	`ConsentKind`	Required
`textVersion`	`string`	Required
`householdMemberId`	`string (uuid) \| null`	—

ProblemDetails

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