Merran documentation API & integrations

What the household always has

GET

/api/households/current/on-hand

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

Left off lists made from the plan: salt, pepper, water and ice to start. Each covers its kinds, so salt is kosher and sea salt too. With an API key, it needs the list: read permission.

Authorizations

session
apiKey

Responses

200

What’s always on hand.

application/json

object

items

required

Left off lists made from the plan. Each covers its kinds: “salt” is kosher and sea salt too.

Array<string>

<= 100 items

Example

{
  "items": [
    "salt",
    "pepper",
    "water",
    "ice",
    "olive oil"
  ]
}

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