Merran documentation API & integrations

Who's signed in

GET

/api/auth/me

const url = 'http://localhost:3000/api/auth/me';
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/auth/me \
  --cookie merran.session_token=<merran.session_token>

The signed-in person, their households and the one in use on this device. Switch households with POST /api/auth/organization/set-active.

Authorizations

session

Responses

200

Signed in.

application/json

object

required

string

name

required

string

email

required

string

username

required

string | null

serverAdmin

required

boolean

households

required

Array<object>

object

required

string

name

required

string

role

required

string

Allowed values: owner admin member

activeHouseholdId

required

string | null

Example

{
  "id": "0199e8b0-5a10-7a01-8b00-000000000001",
  "name": "Sam Rivera",
  "email": "sam@example.com",
  "username": "sam",
  "serverAdmin": true,
  "households": [
    {
      "id": "0199e8b0-5a10-7a01-8b00-000000000003",
      "name": "The Riveras",
      "role": "owner"
    }
  ],
  "activeHouseholdId": "0199e8b0-5a10-7a01-8b00-000000000003"
}

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