getHousehold

GET

/household

const url = 'http://localhost:8080/api/v1/household';
const options = {method: 'GET', headers: {cookie: 'hs_session=<hs_session>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:8080/api/v1/household \
  --cookie hs_session=<hs_session>

Authorizations

cookieAuth
bearerAuth

Responses

200

Household.

application/json

object

required

string

/^[a-z]{2,3}_[0-9a-hjkmnp-tv-z]{26}$/

name

required

string

defaultLocale

required

string

Allowed values: en zh-Hans th

memberCount

required

integer

baseUrl

required

string format: uri

createdAt

required

string format: date-time

Examples

seed

Derived from fixtures/seed.json.

{
  "baseUrl": "http://localhost:5173",
  "createdAt": "2026-09-17T09:00:00.000Z",
  "defaultLocale": "th",
  "id": "hh_01j9vd2c703tt6a613pxhc9s0s",
  "memberCount": 3,
  "name": "The Wongs' Homestead"
}