getInvitePreview

GET

/public/invites/{code}

curl --request GET \
  --url http://localhost:8080/api/v1/public/invites/example

• Your Homestead (default port; replace with your address)

Parameters

Path Parameters

code

required

string

Responses

200

Who invited you and to which household.

Media typeapplication/json

object

householdName

required

string

invitedBy

required

string

role

required

string

Allowed values: member viewer

expiresAt

required

string format: date-time

Examples

Exampleseed

Derived from fixtures/seed.json.

{
  "expiresAt": "2026-10-24T09:00:00.000Z",
  "householdName": "The Wongs' Homestead",
  "invitedBy": "Mali",
  "role": "viewer"
}

404

Not found.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

string

i18nKey

string

detail

string

fields

Array<object>

object

path

required

string

code

required

string

i18nKey

string

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "i18nKey": "example",
  "detail": "example",
  "fields": [
    {
      "path": "example",
      "code": "example",
      "i18nKey": "example"
    }
  ]
}

410

Expired or revoked.

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

code

required

string

i18nKey

string

detail

string

fields

Array<object>

object

path

required

string

code

required

string

i18nKey

string

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "code": "example",
  "i18nKey": "example",
  "detail": "example",
  "fields": [
    {
      "path": "example",
      "code": "example",
      "i18nKey": "example"
    }
  ]
}