Merran documentation API & integrations

The weekly autoplan

GET

/api/plan/autoplan

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

When it runs (a day and hour in the household’s time zone), the meals it fills, whether it puts them on the list, when it runs next and what it did last. With an API key, it needs the plan: read permission.

Authorizations

session
apiKey

Responses

200

The autoplan.

application/json

object

enabled

required

boolean

day

required

The day it runs, 0 for Sunday, in the household’s time zone.

integer

<= 6

hour

required

The hour it runs, 0 to 23, in the household’s time zone.

integer

<= 23

meals

required

The meals it fills, of those the household plans.

Array<string>

>= 1 items <= 4 items

Allowed values: breakfast lunch dinner snack

addToList

required

Whether it puts what the week needs on the list too.

boolean

next

required

When it runs next; none while it’s off.

string | null format: date-time

last

required

Any of:

object
null

object

week

required

The first day of the week it planned.

string

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

required

string format: date-time

planned

required

Meals it filled.

integer

empty

required

Meals that were empty to fill.

integer

listed

required

Lines it put on the list, new or added to.

integer

Example

{
  "enabled": true,
  "day": 6,
  "hour": 9,
  "meals": [
    "dinner"
  ],
  "addToList": true,
  "next": "2026-10-24T16:00:00.000Z",
  "last": {
    "week": "2026-10-19",
    "at": "2026-10-17T16:00:00.000Z",
    "planned": 6,
    "empty": 7,
    "listed": 18
  }
}

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