Skip to content
merran
GitHubInstall

Merran documentation API & integrations

What adding from the plan would add

GET
/api/list/from-plan
curl --request GET \
--url 'http://localhost:3000/api/list/from-plan?from=2026-10-15&to=2026-10-15' \
--cookie merran.session_token=<merran.session_token>

Planned meals from one day to another that aren’t on the list yet, and how many are: the rest of this week if no days are given. Meals with a recipe only; notes aren’t shopped for. With an API key, it needs the list: read permission.

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

Example

2026-10-15
to
string
/^\d{4}-\d{2}-\d{2}$/

Example

2026-10-15

The meals.

Media typeapplication/json
object
meals
required

Planned meals not on the list yet.

Array<object>
object
id
required
string
date
required
string
/^\d{4}-\d{2}-\d{2}$/
anyDay
required
boolean
meal
required
string
Allowed values: breakfast lunch dinner snack
name
required
string
listed
required

How many are on the list already.

integer

Example

{
"meals": [
{
"id": "0199e8b0-5a10-7a01-8b00-00000000001b",
"date": "2026-10-15",
"anyDay": false,
"meal": "dinner",
"name": "Lemon Chicken"
}
],
"listed": 2
}

Days out of order, or too many at once.

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

Not signed in.

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

Not allowed.

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

© 2026 Kyle Johnson. Documentation: CC BY 4.0. Merran: AGPL-3.0-or-later.