See an invite

GET

/api/auth/join/{token}

curl --request GET \
  --url http://localhost:3000/api/auth/join/example

• Your Merran

Which household an invite link is for, before joining.

Parameters

Path Parameters

token

required

string

Responses

200

The invite can be used.

Media typeapplication/json

object

household

required

object

name

required

string

role

required

string

Allowed values: admin member

expiresAt

required

string format: date-time

Example

{
  "household": {
    "name": "The Riveras"
  },
  "role": "member",
  "expiresAt": "2026-10-22T18:30:00.000Z"
}

404

No invite has that link.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}

410

The link has been used, or has expired.

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

fields

object

key

additional properties

string

Example

{
  "error": {
    "code": "not_found",
    "message": "There's nothing here.",
    "fields": {
      "name": "Give it a name."
    }
  }
}