Merran documentation API & integrations

Export your data

GET

/api/auth/me/export

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

Your account, the households you’re in, the cooking notes you wrote, and your API keys (never the keys themselves), as a JSON file to keep. A household’s recipes are in the household’s export.

Authorizations

session

Responses

200

Your data, to download.

application/json

object

format

required

string

Allowed values: merran.person

version

required

number

exportedAt

required

string format: date-time

account

required

object

name

required

string

email

required

string

username

required

string | null

createdAt

required

string format: date-time

preferences

required

object

key

additional properties

households

required

Array<object>

object

name

required

string

role

required

string

joinedAt

required

string format: date-time

cookingNotes

required

Array<object>

object

household

required

string

recipe

required

string

rating

required

number | null

note

required

string | null

createdAt

required

string format: date-time

apiKeys

required

Array<object>

object

name

required

string

household

required

string

permissions

required

object

key

additional properties

string

createdAt

required

string format: date-time

lastUsedAt

required

string | null format: date-time

expiresAt

required

string | null format: date-time

Example

{
  "format": "merran.person",
  "version": 1,
  "exportedAt": "2026-10-15T18:30:00.000Z",
  "account": {
    "name": "Sam Rivera",
    "email": "sam@example.com",
    "username": "sam",
    "createdAt": "2026-10-01T17:30:00.000Z",
    "preferences": {}
  },
  "households": [
    {
      "name": "The Riveras",
      "role": "owner",
      "joinedAt": "2026-10-01T17:30:00.000Z"
    }
  ],
  "cookingNotes": [
    {
      "household": "The Riveras",
      "recipe": "Lemon Chicken",
      "rating": 5,
      "note": "More lemon next time.",
      "createdAt": "2026-10-09T01:15:00.000Z"
    }
  ],
  "apiKeys": [
    {
      "name": "Home Assistant",
      "household": "The Riveras",
      "permissions": {
        "recipes": "read",
        "list": "write"
      },
      "createdAt": "2026-10-01T17:30:00.000Z",
      "lastUsedAt": "2026-10-15T18:30:00.000Z",
      "expiresAt": "2027-01-13T18: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."
    }
  }
}