Schemas

Shared.ActiveHouseholdData

id

string · required

slug

string · required

name

string · required

ownerId

string | null

Auth.ApiKeyPublicData

id

string · required

name

string · required

tokenPrefix

string · required

abilities

string[] · required

createdAt

string · date-time · required

kind

string · enum · required

Enum values:

mobile

desktop

lastUsedAt

string | null · date-time

Auth.ConfirmPasswordResetResponseData

status

string · required

redirectTo

string · required

Auth.CreateApiKeyRequestData

Request body for POST /v1/api-keys (API-14). - `name` — human label (required, max 80 chars). - `abilities` — list of strings from the Abilities enum whitelist (D-11). Abilities are validated against Abilities::values() — any non-whitelisted string fails validation with a 422 RFC 9457 envelope.

abilities

object

Auth.CreateApiKeyResponseData

Auth.ApiKeyPublicData · required

token

string · required

Auth.EmailVerificationNotificationResponseData

status

string · required

Auth.InviteLandingData

inviterName

string · required

householdName

string · required

role

string · required

state

string · required

expiresAt

string · required

Auth.LoginResponseData

Auth.UserSessionData · required

Auth.SessionData · required

abilities

string[] · required

token

string | null

Auth.OAuthLinkConsumeResponseData

status

string · required

redirectTo

string · required

Auth.OAuthLinkDecision

string · enum

Enum values:

link

create-new

cancel

Cross-provider OAuth-link decision — backed enum carried as the path parameter of POST /v1/auth/oauth-links/{decision}. Gap-fix 13.3-G-D9. No-magic-strings (CLAUDE.md) — the SPA's three CTAs on OAuthLinkPromptPage.vue (oauth-link-link-cta, oauth-link-create-new-cta, oauth-link-cancel-cta) MUST round-trip through this enum on the server, never as a free-form string. Semantics: - link → consume the pending OAuth identity by attaching it to the calling user's account (ConsumeOAuthLinkCommand). - create-new → discard the pending state; SPA bounces the user to /auth/register so they can start a fresh account (the calling session stays intact). - cancel → discard the pending state; SPA navigates away.

Auth.OAuthLinkPendingData

provider

string · required

email

string · required

suggestedUserId

integer | null

suggestedUserName

string | null

Auth.RequestMagicLinkResponseData

status

string · required

retryAfterSeconds

integer · required

Auth.RequestPasswordResetResponseData

status

string · required

retryAfterSeconds

integer · required

Auth.SessionData

userId

string · required

email

string · required

authenticatedAt

string · date-time · required

Shared.UserProfileData

id

string · required

email

string · required

name

string · required

locale

string · required

themePreference

string · required

weekStart

string · required

timeFormat

string · required

createdAt

string · date-time · required

entitlements

string[] · required

Shared.ActiveHouseholdData

Auth.UserSessionData

id

string · required

email

string · required

name

string · required

locale

string · required

authenticatedAt

string · date-time · required

Happklaar API

Schemas

Shared.ActiveHouseholdData

id

string · required

slug

string · required

name

string · required

ownerId

string | null

Auth.ApiKeyPublicData

id

string · required

name

string · required

tokenPrefix

string · required

abilities

string[] · required

createdAt

string · date-time · required

kind

string · enum · required

Enum values:

mobile

desktop

lastUsedAt

string | null · date-time

Auth.ConfirmPasswordResetResponseData

status

string · required

redirectTo

string · required

Auth.CreateApiKeyRequestData

abilities

object

Auth.CreateApiKeyResponseData

Auth.ApiKeyPublicData · required

token

string · required

Auth.EmailVerificationNotificationResponseData

status

string · required

Auth.InviteLandingData

inviterName

string · required

householdName

string · required

role

string · required

state

string · required

expiresAt

string · required

Auth.LoginResponseData

Auth.UserSessionData · required

Auth.SessionData · required

abilities

string[] · required

token

string | null

Auth.OAuthLinkConsumeResponseData

status

string · required

redirectTo

string · required

Auth.OAuthLinkDecision

string · enum

Enum values:

link

create-new

cancel

Auth.OAuthLinkPendingData

provider

string · required

email

string · required

suggestedUserId

integer | null

suggestedUserName

string | null

Auth.RequestMagicLinkResponseData

status

string · required

retryAfterSeconds

integer · required

Auth.RequestPasswordResetResponseData

status

string · required

retryAfterSeconds

integer · required

Auth.SessionData

userId

string · required

email

string · required

authenticatedAt

string · date-time · required

Shared.UserProfileData

id

string · required

email

string · required

name

string · required

locale

string · required

themePreference

string · required

weekStart

string · required

timeFormat

string · required

createdAt

string · date-time · required

entitlements

string[] · required

Shared.ActiveHouseholdData

Auth.UserSessionData

id

string · required

email

string · required

name

string · required

locale

string · required

authenticatedAt

string · date-time · required