Merran documentation API & integrations

The plan for some days

GET

/api/plan

const url = 'http://localhost:3000/api/plan?from=2026-10-15&to=2026-10-15';
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/plan?from=2026-10-15&to=2026-10-15' \
  --cookie merran.session_token=<merran.session_token>

Meals from one day to another, up to 62 days apart, in a day’s order: this week’s if no days are given. A week’s pool (meals for any day of it) is dated to the week’s first day, with anyDay set. Meals of recipes in Recently deleted are left out until they’re restored. With an API key, it needs the plan: read permission.

Authorizations

session
apiKey

Parameters

Query Parameters

from

The first day. This week’s first day if left out.

string

/^\d{4}-\d{2}-\d{2}$/

Example

2026-10-15

The first day. This week’s first day if left out.

The last day. Six days after from if left out.

string

/^\d{4}-\d{2}-\d{2}$/

Example

2026-10-15

The last day. Six days after from if left out.

Responses

200

The meals.

application/json

object

entries

required

Array<object>

object

required

string

date

required

Its day, or for the week’s pool, the week’s first day.

string

/^\d{4}-\d{2}-\d{2}$/

anyDay

required

In the week’s pool: for any day of the week.

boolean

meal

required

string

Allowed values: breakfast lunch dinner snack

position

required

Its place among the meal’s dishes.

integer

status

required

string

Allowed values: planned cooked skipped

recipe

required

Null for a note.

object

required

string

slug

required

string

name

required

string

photo

required

string | null

servings

required

number | null

totalMinutes

required

integer | null

calories

required

In a serving, when its nutrition is known.

number | null

withRecipe

required

What it’s made with: “with peanut sauce”.

object

required

string

slug

required

string

name

required

string

calories

required

number | null

note

required

A meal that isn’t a recipe: “leftovers”.

string | null

servings

required

Null for the recipe’s own servings.

number | null

why

required

Why it was picked, when Fill the week picked it: none otherwise.

Array

<= 5 items

One of:

object

kind

required

string

Allowed values: theme

label

required

string

<= 60 characters

createdAt

required

string format: date-time

Example

{
  "entries": [
    {
      "id": "0199e8b0-5a10-7a01-8b00-00000000001b",
      "date": "2026-10-15",
      "anyDay": false,
      "meal": "dinner",
      "position": 0,
      "status": "planned",
      "recipe": {
        "id": "0199e8b0-5a10-7a01-8b00-000000000006",
        "slug": "lemon-chicken",
        "name": "Lemon Chicken",
        "photo": null,
        "servings": 4,
        "totalMinutes": 50,
        "calories": 412
      },
      "withRecipe": {
        "id": "0199e8b0-5a10-7a01-8b00-000000000007",
        "slug": "garlic-rice",
        "name": "Garlic Rice",
        "calories": 210
      },
      "note": null,
      "servings": null,
      "why": [
        {
          "kind": "theme",
          "label": "Taco night"
        }
      ],
      "createdAt": "2026-10-15T18:30:00.000Z"
    }
  ]
}

400

Not days, or too many of them.

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

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