Merran documentation API & integrations

Who's in the household

GET

/api/households/current/members

const url = 'http://localhost:3000/api/households/current/members';
const options = {
  method: 'GET',
  headers: {cookie: 'merran.session_token=<merran.session_token>'}
};

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:3000/api/households/current/members \
  --cookie merran.session_token=<merran.session_token>

With an API key, it needs the household: read permission.

Authorizations

session
apiKey

Responses

200

Its people, longest-standing first.

application/json

Array<object>

object

required

string

userId

required

string

name

required

string

username

required

string | null

role

required

string

Allowed values: owner admin member

joinedAt

required

string format: date-time

Example

[
  {
    "id": "0199e8b0-5a10-7a01-8b00-000000000005",
    "userId": "0199e8b0-5a10-7a01-8b00-000000000002",
    "name": "Jamie Rivera",
    "username": "jamie",
    "role": "admin",
    "joinedAt": "2026-10-01T17:30:00.000Z"
  }
]

401

Not signed in.

application/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."
    }
  }
}

403

Not allowed.

application/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."
    }
  }
}