API docs by Redocly

Mealie (develop)

Download OpenAPI specification:Download

Mealie is a web application for managing your recipes, meal plans, and shopping lists. This is the Restful API interactive documentation that can be used to explore the API. If you're justing getting started with the API and want to get started quickly, you can use the API Usage | Mealie Docs as a reference for how to get started.

If you have any questions or comments about mealie, please use the discord server to talk to the developers or other community members. If you'd like to file an issue, please use the GitHub Issue Tracker | Mealie

App: About

Get App Info

Get general application information

Responses

Response samples

Content type
application/json
{
  • "production": true,
  • "version": "string",
  • "demoStatus": true,
  • "allowSignup": true,
  • "defaultGroupSlug": "string",
  • "defaultHouseholdSlug": "string",
  • "enableOidc": true,
  • "oidcRedirect": true,
  • "oidcProviderName": "string",
  • "enableOpenai": true,
  • "enableOpenaiImageServices": true
}

Get Startup Info

returns helpful startup information

Responses

Response samples

Content type
application/json
{
  • "isFirstLogin": true,
  • "isDemo": true
}

Get App Theme

Get's the current theme settings

Responses

Response samples

Content type
application/json
{
  • "lightPrimary": "#E58325",
  • "lightAccent": "#007A99",
  • "lightSecondary": "#973542",
  • "lightSuccess": "#43A047",
  • "lightInfo": "#1976D2",
  • "lightWarning": "#FF6D00",
  • "lightError": "#EF5350",
  • "darkPrimary": "#E58325",
  • "darkAccent": "#007A99",
  • "darkSecondary": "#973542",
  • "darkSuccess": "#43A047",
  • "darkInfo": "#1976D2",
  • "darkWarning": "#FF6D00",
  • "darkError": "#EF5350"
}

Users: Authentication

Get Token

Request Body schema: application/x-www-form-urlencoded
username
string (Username)
Default: ""
password
string (Password)
Default: ""
remember_me
boolean (Remember Me)
Default: false

Responses

Response samples

Content type
application/json
null

Oauth Login

Responses

Response samples

Content type
application/json
null

Oauth Callback

Responses

Response samples

Content type
application/json
null

Refresh Token

Use a valid token to get another token

Authorizations:
OAuth2PasswordBearer

Responses

Response samples

Content type
application/json
null

Logout

Authorizations:
OAuth2PasswordBearer

Responses

Response samples

Content type
application/json
null

Users: Registration

Register New User

header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Group (string) or Group (null) (Group)
Household (string) or Household (null) (Household)
Grouptoken (string) or Grouptoken (null) (Grouptoken)
email
required
string (Email)
username
required
string (Username)
fullName
required
string (Fullname)
password
required
string (Password)
passwordConfirm
required
string (Passwordconfirm)
advanced
boolean (Advanced)
Default: false
private
boolean (Private)
Default: false
seedData
boolean (Seeddata)
Default: false
locale
string (Locale)
Default: "en-US"

Responses

Request samples

Content type
application/json
{
  • "group": "string",
  • "household": "string",
  • "groupToken": "string",
  • "email": "string",
  • "username": "string",
  • "fullName": "string",
  • "password": "string",
  • "passwordConfirm": "string",
  • "advanced": false,
  • "private": false,
  • "seedData": false,
  • "locale": "en-US"
}

Response samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Users: CRUD

Get Logged In User

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Get Logged In User Ratings

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "ratings": [
    ]
}

Get Logged In User Rating For Recipe

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
recipe_id
required
string <uuid4> (Recipe Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "recipeId": "string",
  • "rating": 0,
  • "isFavorite": false
}

Get Logged In User Favorites

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "ratings": [
    ]
}

Update Password

Resets the User Password

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
currentPassword
string (Currentpassword)
Default: ""
newPassword
required
string (Newpassword) >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "",
  • "newPassword": "stringst"
}

Response samples

Content type
application/json
null

Update User

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Id (string) or Id (null) (Id)
Username (string) or Username (null) (Username)
Fullname (string) or Fullname (null) (Fullname)
email
required
string (Email)
authMethod
string (AuthMethod)
Default: "Mealie"
Enum: "Mealie" "LDAP" "OIDC"
admin
boolean (Admin)
Default: false
Group (string) or Group (null) (Group)
Household (string) or Household (null) (Household)
advanced
boolean (Advanced)
Default: false
canInvite
boolean (Caninvite)
Default: false
canManage
boolean (Canmanage)
Default: false
canManageHousehold
boolean (Canmanagehousehold)
Default: false
canOrganize
boolean (Canorganize)
Default: false

Responses

Request samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Response samples

Content type
application/json
null

Users: Admin CRUD

Get User

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Delete User

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Get All

Returns all users from all groups

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create User

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Id (string) or Id (null) (Id)
username
required
string (Username)
fullName
required
string (Fullname)
email
required
string (Email)
authMethod
string (AuthMethod)
Default: "Mealie"
Enum: "Mealie" "LDAP" "OIDC"
admin
boolean (Admin)
Default: false
Group (string) or Group (null) (Group)
Household (string) or Household (null) (Household)
advanced
boolean (Advanced)
Default: false
canInvite
boolean (Caninvite)
Default: false
canManage
boolean (Canmanage)
Default: false
canManageHousehold
boolean (Canmanagehousehold)
Default: false
canOrganize
boolean (Canorganize)
Default: false
password
required
string (Password)

Responses

Request samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Response samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Users: Passwords

Forgot Password

Sends an email with a reset link to the user

header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
email
required
string (Email)

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
null

Reset Password

Resets the user password

Request Body schema: application/json
required
token
required
string (Token)
email
required
string (Email)
password
required
string (Password)
passwordConfirm
required
string (Passwordconfirm)

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "email": "string",
  • "password": "string",
  • "passwordConfirm": "string"
}

Response samples

Content type
application/json
null

Users: Images

Update User Image

Updates a User Image

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
id
required
string <uuid4> (Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: multipart/form-data
required
profile
required
string <binary> (Profile)

Responses

Response samples

Content type
application/json
null

Users: Tokens

Create Api Token

Create api_token in the Database

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)
integrationId
string (Integrationid)
Default: "generic"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "integrationId": "generic"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "token": "string"
}

Delete Api Token

Delete api_token from the Database

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
token_id
required
integer (Token Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "tokenDelete": "string"
}

Users: Ratings

Get Ratings

Get user's rated recipes

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
id
required
string <uuid4> (Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "ratings": [
    ]
}

Get Favorites

Get user's favorited recipes

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
id
required
string <uuid4> (Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "ratings": [
    ]
}

Set Rating

Sets the user's rating for a recipe

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
id
required
string <uuid4> (Id)
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Rating (number) or Rating (null) (Rating)
Isfavorite (boolean) or Isfavorite (null) (Isfavorite)

Responses

Request samples

Content type
application/json
{
  • "rating": 0,
  • "isFavorite": true
}

Response samples

Content type
application/json
null

Add Favorite

Adds a recipe to the user's favorites

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
id
required
string <uuid4> (Id)
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Remove Favorite

Removes a recipe from the user's favorites

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
id
required
string <uuid4> (Id)
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Households: Cookbooks

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)
description
string (Description)
Default: ""
Slug (string) or Slug (null) (Slug)
position
integer (Position)
Default: 1
public
boolean (Public)
Default: false
queryFilterString
string (Queryfilterstring)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "",
  • "slug": "string",
  • "position": 1,
  • "public": false,
  • "queryFilterString": ""
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "",
  • "slug": "string",
  • "position": 1,
  • "public": false,
  • "queryFilterString": "",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string",
  • "queryFilter": {
    }
}

Update Many

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Array
name
required
string (Name)
description
string (Description)
Default: ""
Slug (string) or Slug (null) (Slug)
position
integer (Position)
Default: 1
public
boolean (Public)
Default: false
queryFilterString
string (Queryfilterstring)
Default: ""
groupId
required
string <uuid4> (Groupid)
householdId
required
string <uuid4> (Householdid)
id
required
string <uuid4> (Id)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
required
Item Id (string) or Item Id (string) (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "",
  • "slug": "string",
  • "position": 1,
  • "public": false,
  • "queryFilterString": "",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string",
  • "queryFilter": {
    },
  • "recipes": [
    ]
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)
description
string (Description)
Default: ""
Slug (string) or Slug (null) (Slug)
position
integer (Position)
Default: 1
public
boolean (Public)
Default: false
queryFilterString
string (Queryfilterstring)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "",
  • "slug": "string",
  • "position": 1,
  • "public": false,
  • "queryFilterString": ""
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "",
  • "slug": "string",
  • "position": 1,
  • "public": false,
  • "queryFilterString": "",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string",
  • "queryFilter": {
    }
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "",
  • "slug": "string",
  • "position": 1,
  • "public": false,
  • "queryFilterString": "",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string",
  • "queryFilter": {
    }
}

Households: Event Notifications

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)
Appriseurl (string) or Appriseurl (null) (Appriseurl)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "appriseUrl": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "enabled": true,
  • "groupId": "string",
  • "householdId": "string",
  • "options": {
    }
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "enabled": true,
  • "groupId": "string",
  • "householdId": "string",
  • "options": {
    }
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)
Appriseurl (string) or Appriseurl (null) (Appriseurl)
enabled
boolean (Enabled)
Default: true
groupId
required
string <uuid4> (Groupid)
householdId
required
string <uuid4> (Householdid)
object (GroupEventNotifierOptions)
Default: {"testMessage":false,"webhookTask":false,"recipeCreated":false,"recipeUpdated":false,"recipeDeleted":false,"userSignup":false,"dataMigrations":false,"dataExport":false,"dataImport":false,"mealplanEntryCreated":false,"shoppingListCreated":false,"shoppingListUpdated":false,"shoppingListDeleted":false,"cookbookCreated":false,"cookbookUpdated":false,"cookbookDeleted":false,"tagCreated":false,"tagUpdated":false,"tagDeleted":false,"categoryCreated":false,"categoryUpdated":false,"categoryDeleted":false}

These events are in-sync with the EventTypes found in the EventBusService. If you modify this, make sure to update the EventBusService as well.

id
required
string <uuid4> (Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "appriseUrl": "string",
  • "enabled": true,
  • "groupId": "string",
  • "householdId": "string",
  • "options": {
    },
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "enabled": true,
  • "groupId": "string",
  • "householdId": "string",
  • "options": {
    }
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Test Notification

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Households: Recipe Actions

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
actionType
required
string (GroupRecipeActionType)
Enum: "link" "post"
title
required
string (Title)
url
required
string (Url)

Responses

Request samples

Content type
application/json
{
  • "actionType": "link",
  • "title": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "actionType": "link",
  • "title": "string",
  • "url": "string",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string"
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "actionType": "link",
  • "title": "string",
  • "url": "string",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string"
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
actionType
required
string (GroupRecipeActionType)
Enum: "link" "post"
title
required
string (Title)
url
required
string (Url)
groupId
required
string <uuid4> (Groupid)
householdId
required
string <uuid4> (Householdid)

Responses

Request samples

Content type
application/json
{
  • "actionType": "link",
  • "title": "string",
  • "url": "string",
  • "groupId": "string",
  • "householdId": "string"
}

Response samples

Content type
application/json
{
  • "actionType": "link",
  • "title": "string",
  • "url": "string",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string"
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "actionType": "link",
  • "title": "string",
  • "url": "string",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string"
}

Trigger Action

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
recipe_slug
required
string (Recipe Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Households: Self Service

Get Logged In User Household

Returns the Household Data for the Current User

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "groupId": "string",
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "preferences": {
    },
  • "group": "string",
  • "users": [
    ],
  • "webhooks": [ ]
}

Get Household Recipe

Returns recipe data for the current household

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
recipe_slug
required
string (Recipe Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "lastMade": "2019-08-24T14:15:22Z",
  • "recipeId": "string"
}

Get Household Members

Returns all users belonging to the current household

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Get Household Preferences

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "privateHousehold": true,
  • "lockRecipeEditsFromOtherHouseholds": true,
  • "firstDayOfWeek": 0,
  • "recipePublic": true,
  • "recipeShowNutrition": false,
  • "recipeShowAssets": false,
  • "recipeLandscapeView": false,
  • "recipeDisableComments": false,
  • "recipeDisableAmount": true,
  • "id": "string"
}

Update Household Preferences

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
privateHousehold
boolean (Privatehousehold)
Default: true
lockRecipeEditsFromOtherHouseholds
boolean (Lockrecipeeditsfromotherhouseholds)
Default: true
firstDayOfWeek
integer (Firstdayofweek)
Default: 0
recipePublic
boolean (Recipepublic)
Default: true
recipeShowNutrition
boolean (Recipeshownutrition)
Default: false
recipeShowAssets
boolean (Recipeshowassets)
Default: false
recipeLandscapeView
boolean (Recipelandscapeview)
Default: false
recipeDisableComments
boolean (Recipedisablecomments)
Default: false
recipeDisableAmount
boolean (Recipedisableamount)
Default: true

Responses

Request samples

Content type
application/json
{
  • "privateHousehold": true,
  • "lockRecipeEditsFromOtherHouseholds": true,
  • "firstDayOfWeek": 0,
  • "recipePublic": true,
  • "recipeShowNutrition": false,
  • "recipeShowAssets": false,
  • "recipeLandscapeView": false,
  • "recipeDisableComments": false,
  • "recipeDisableAmount": true
}

Response samples

Content type
application/json
{
  • "privateHousehold": true,
  • "lockRecipeEditsFromOtherHouseholds": true,
  • "firstDayOfWeek": 0,
  • "recipePublic": true,
  • "recipeShowNutrition": false,
  • "recipeShowAssets": false,
  • "recipeLandscapeView": false,
  • "recipeDisableComments": false,
  • "recipeDisableAmount": true,
  • "id": "string"
}

Set Member Permissions

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
userId
required
string <uuid4> (Userid)
canManageHousehold
boolean (Canmanagehousehold)
Default: false
canManage
boolean (Canmanage)
Default: false
canInvite
boolean (Caninvite)
Default: false
canOrganize
boolean (Canorganize)
Default: false

Responses

Request samples

Content type
application/json
{
  • "userId": "string",
  • "canManageHousehold": false,
  • "canManage": false,
  • "canInvite": false,
  • "canOrganize": false
}

Response samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Get Statistics

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "totalRecipes": 0,
  • "totalUsers": 0,
  • "totalCategories": 0,
  • "totalTags": 0,
  • "totalTools": 0
}

Households: Invitations

Get Invite Tokens

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Invite Token

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
uses
required
integer (Uses)
Groupid (string) or Groupid (null) (Groupid)
Householdid (string) or Householdid (null) (Householdid)

Responses

Request samples

Content type
application/json
{
  • "uses": 0,
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "householdId": "b5d33c47-da83-44b4-b7bf-7ab3c5485f36"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "usesLeft": 0,
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "householdId": "b5d33c47-da83-44b4-b7bf-7ab3c5485f36"
}

Email Invitation

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
email
required
string (Email)
token
required
string (Token)

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "token": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Households: Shopping Lists

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Extras (object) or Extras (null) (Extras)
Default: {}
Createdat (string) or Createdat (null) (Createdat)
Update At (string) or Update At (null) (Update At)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "extras": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "update_at": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "extras": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "groupId": "string",
  • "userId": "string",
  • "id": "string",
  • "listItems": [ ],
  • "householdId": "string",
  • "recipeReferences": [ ],
  • "labelSettings": [ ]
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "extras": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "groupId": "string",
  • "userId": "string",
  • "id": "string",
  • "listItems": [ ],
  • "householdId": "string",
  • "recipeReferences": [ ],
  • "labelSettings": [ ]
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)
Extras (object) or Extras (null) (Extras)
Default: {}
Createdat (string) or Createdat (null) (Createdat)
Update At (string) or Update At (null) (Update At)
groupId
required
string <uuid4> (Groupid)
userId
required
string <uuid4> (Userid)
id
required
string <uuid4> (Id)
Array of objects (Listitems)
Default: []

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "extras": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "update_at": "2019-08-24T14:15:22Z",
  • "groupId": "string",
  • "userId": "string",
  • "id": "string",
  • "listItems": [ ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "extras": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "groupId": "string",
  • "userId": "string",
  • "id": "string",
  • "listItems": [ ],
  • "householdId": "string",
  • "recipeReferences": [ ],
  • "labelSettings": [ ]
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "extras": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "groupId": "string",
  • "userId": "string",
  • "id": "string",
  • "listItems": [ ],
  • "householdId": "string",
  • "recipeReferences": [ ],
  • "labelSettings": [ ]
}

Update Label Settings

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Array
shoppingListId
required
string <uuid4> (Shoppinglistid)
labelId
required
string <uuid4> (Labelid)
position
integer (Position)
Default: 0
id
required
string <uuid4> (Id)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "name": "string",
  • "extras": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "groupId": "string",
  • "userId": "string",
  • "id": "string",
  • "listItems": [ ],
  • "householdId": "string",
  • "recipeReferences": [ ],
  • "labelSettings": [ ]
}

Add Recipe Ingredients To List

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Array
recipeIncrementQuantity
number (Recipeincrementquantity)
Default: 1
Array of Recipeingredients (objects) or Recipeingredients (null) (Recipeingredients)
recipeId
required
string <uuid4> (Recipeid)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "name": "string",
  • "extras": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "groupId": "string",
  • "userId": "string",
  • "id": "string",
  • "listItems": [ ],
  • "householdId": "string",
  • "recipeReferences": [ ],
  • "labelSettings": [ ]
}

Add Single Recipe Ingredients To List Deprecated

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
recipe_id
required
string <uuid4> (Recipe Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
Any of
recipeIncrementQuantity
number (Recipeincrementquantity)
Default: 1
Array of Recipeingredients (objects) or Recipeingredients (null) (Recipeingredients)

Responses

Request samples

Content type
application/json
Example
{
  • "recipeIncrementQuantity": 1,
  • "recipeIngredients": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "extras": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "groupId": "string",
  • "userId": "string",
  • "id": "string",
  • "listItems": [ ],
  • "householdId": "string",
  • "recipeReferences": [ ],
  • "labelSettings": [ ]
}

Remove Recipe Ingredients From List

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
recipe_id
required
string <uuid4> (Recipe Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
Any of
recipeDecrementQuantity
number (Recipedecrementquantity)
Default: 1

Responses

Request samples

Content type
application/json
Example
{
  • "recipeDecrementQuantity": 1
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "extras": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "groupId": "string",
  • "userId": "string",
  • "id": "string",
  • "listItems": [ ],
  • "householdId": "string",
  • "recipeReferences": [ ],
  • "labelSettings": [ ]
}

Households: Shopping List Items

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
quantity
number (Quantity)
Default: 1
IngredientUnit (object) or CreateIngredientUnit (object) or Unit (null) (Unit)
IngredientFood (object) or CreateIngredientFood (object) or Food (null) (Food)
Note (string) or Note (null) (Note)
Default: ""
isFood
boolean (Isfood)
Default: false
Disableamount (boolean) or Disableamount (null) (Disableamount)
display
string (Display)
Default: ""
shoppingListId
required
string <uuid4> (Shoppinglistid)
checked
boolean (Checked)
Default: false
position
integer (Position)
Default: 0
Foodid (string) or Foodid (null) (Foodid)
Labelid (string) or Labelid (null) (Labelid)
Unitid (string) or Unitid (null) (Unitid)
Extras (object) or Extras (null) (Extras)
Default: {}
Id (string) or Id (null) (Id)
Array of objects (Recipereferences)
Default: []

Responses

Request samples

Content type
application/json
{
  • "quantity": 1,
  • "unit": {
    },
  • "food": {
    },
  • "note": "",
  • "isFood": false,
  • "disableAmount": true,
  • "display": "",
  • "shoppingListId": "string",
  • "checked": false,
  • "position": 0,
  • "foodId": "string",
  • "labelId": "string",
  • "unitId": "string",
  • "extras": { },
  • "id": "string",
  • "recipeReferences": [ ]
}

Response samples

Content type
application/json
{
  • "createdItems": [ ],
  • "updatedItems": [ ],
  • "deletedItems": [ ]
}

Update Many

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Array
quantity
number (Quantity)
Default: 1
IngredientUnit (object) or CreateIngredientUnit (object) or Unit (null) (Unit)
IngredientFood (object) or CreateIngredientFood (object) or Food (null) (Food)
Note (string) or Note (null) (Note)
Default: ""
isFood
boolean (Isfood)
Default: false
Disableamount (boolean) or Disableamount (null) (Disableamount)
display
string (Display)
Default: ""
shoppingListId
required
string <uuid4> (Shoppinglistid)
checked
boolean (Checked)
Default: false
position
integer (Position)
Default: 0
Foodid (string) or Foodid (null) (Foodid)
Labelid (string) or Labelid (null) (Labelid)
Unitid (string) or Unitid (null) (Unitid)
Extras (object) or Extras (null) (Extras)
Default: {}
Array of ShoppingListItemRecipeRefCreate (object) or ShoppingListItemRecipeRefUpdate (object) (Recipereferences)
Default: []
id
required
string <uuid4> (Id)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "createdItems": [ ],
  • "updatedItems": [ ],
  • "deletedItems": [ ]
}

Delete Many

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
ids
Array of strings <uuid4> (Ids) [ items <uuid4 > ]
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Create Many

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Array
quantity
number (Quantity)
Default: 1
IngredientUnit (object) or CreateIngredientUnit (object) or Unit (null) (Unit)
IngredientFood (object) or CreateIngredientFood (object) or Food (null) (Food)
Note (string) or Note (null) (Note)
Default: ""
isFood
boolean (Isfood)
Default: false
Disableamount (boolean) or Disableamount (null) (Disableamount)
display
string (Display)
Default: ""
shoppingListId
required
string <uuid4> (Shoppinglistid)
checked
boolean (Checked)
Default: false
position
integer (Position)
Default: 0
Foodid (string) or Foodid (null) (Foodid)
Labelid (string) or Labelid (null) (Labelid)
Unitid (string) or Unitid (null) (Unitid)
Extras (object) or Extras (null) (Extras)
Default: {}
Id (string) or Id (null) (Id)
Array of objects (Recipereferences)
Default: []

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "createdItems": [ ],
  • "updatedItems": [ ],
  • "deletedItems": [ ]
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "quantity": 1,
  • "unit": {
    },
  • "food": {
    },
  • "note": "",
  • "isFood": false,
  • "disableAmount": true,
  • "display": "",
  • "shoppingListId": "string",
  • "checked": false,
  • "position": 0,
  • "foodId": "string",
  • "labelId": "string",
  • "unitId": "string",
  • "extras": { },
  • "id": "string",
  • "groupId": "string",
  • "householdId": "string",
  • "label": {
    },
  • "recipeReferences": [ ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
quantity
number (Quantity)
Default: 1
IngredientUnit (object) or CreateIngredientUnit (object) or Unit (null) (Unit)
IngredientFood (object) or CreateIngredientFood (object) or Food (null) (Food)
Note (string) or Note (null) (Note)
Default: ""
isFood
boolean (Isfood)
Default: false
Disableamount (boolean) or Disableamount (null) (Disableamount)
display
string (Display)
Default: ""
shoppingListId
required
string <uuid4> (Shoppinglistid)
checked
boolean (Checked)
Default: false
position
integer (Position)
Default: 0
Foodid (string) or Foodid (null) (Foodid)
Labelid (string) or Labelid (null) (Labelid)
Unitid (string) or Unitid (null) (Unitid)
Extras (object) or Extras (null) (Extras)
Default: {}
Array of ShoppingListItemRecipeRefCreate (object) or ShoppingListItemRecipeRefUpdate (object) (Recipereferences)
Default: []

Responses

Request samples

Content type
application/json
{
  • "quantity": 1,
  • "unit": {
    },
  • "food": {
    },
  • "note": "",
  • "isFood": false,
  • "disableAmount": true,
  • "display": "",
  • "shoppingListId": "string",
  • "checked": false,
  • "position": 0,
  • "foodId": "string",
  • "labelId": "string",
  • "unitId": "string",
  • "extras": { },
  • "recipeReferences": [ ]
}

Response samples

Content type
application/json
{
  • "createdItems": [ ],
  • "updatedItems": [ ],
  • "deletedItems": [ ]
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Households: Webhooks

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
enabled
boolean (Enabled)
Default: true
name
string (Name)
Default: ""
url
string (Url)
Default: ""
webhookType
string (WebhookType)
Default: "mealplan"
Value: "mealplan"
scheduledTime
required
string <time> (Scheduledtime)

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "name": "",
  • "url": "",
  • "webhookType": "mealplan",
  • "scheduledTime": "14:15:22Z"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "name": "",
  • "url": "",
  • "webhookType": "mealplan",
  • "scheduledTime": "14:15:22Z",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string"
}

Rerun Webhooks

Manually re-fires all previously scheduled webhooks for today

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "name": "",
  • "url": "",
  • "webhookType": "mealplan",
  • "scheduledTime": "14:15:22Z",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string"
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
enabled
boolean (Enabled)
Default: true
name
string (Name)
Default: ""
url
string (Url)
Default: ""
webhookType
string (WebhookType)
Default: "mealplan"
Value: "mealplan"
scheduledTime
required
string <time> (Scheduledtime)

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "name": "",
  • "url": "",
  • "webhookType": "mealplan",
  • "scheduledTime": "14:15:22Z"
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "name": "",
  • "url": "",
  • "webhookType": "mealplan",
  • "scheduledTime": "14:15:22Z",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string"
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "enabled": true,
  • "name": "",
  • "url": "",
  • "webhookType": "mealplan",
  • "scheduledTime": "14:15:22Z",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string"
}

Test One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Households: Mealplan Rules

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
day
string (PlanRulesDay)
Default: "unset"
Enum: "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" "sunday" "unset"
entryType
string (PlanRulesType)
Default: "unset"
Enum: "breakfast" "lunch" "dinner" "side" "unset"
queryFilterString
string (Queryfilterstring)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "day": "monday",
  • "entryType": "breakfast",
  • "queryFilterString": ""
}

Response samples

Content type
application/json
{
  • "day": "monday",
  • "entryType": "breakfast",
  • "queryFilterString": "",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string",
  • "queryFilter": {
    }
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "day": "monday",
  • "entryType": "breakfast",
  • "queryFilterString": "",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string",
  • "queryFilter": {
    }
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
day
string (PlanRulesDay)
Default: "unset"
Enum: "monday" "tuesday" "wednesday" "thursday" "friday" "saturday" "sunday" "unset"
entryType
string (PlanRulesType)
Default: "unset"
Enum: "breakfast" "lunch" "dinner" "side" "unset"
queryFilterString
string (Queryfilterstring)
Default: ""

Responses

Request samples

Content type
application/json
{
  • "day": "monday",
  • "entryType": "breakfast",
  • "queryFilterString": ""
}

Response samples

Content type
application/json
{
  • "day": "monday",
  • "entryType": "breakfast",
  • "queryFilterString": "",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string",
  • "queryFilter": {
    }
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "day": "monday",
  • "entryType": "breakfast",
  • "queryFilterString": "",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string",
  • "queryFilter": {
    }
}

Households: Mealplans

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Start Date (string) or Start Date (null) (Start Date)
End Date (string) or End Date (null) (End Date)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
date
required
string <date> (Date)
entryType
string (PlanEntryType)
Default: "breakfast"
Enum: "breakfast" "lunch" "dinner" "side"
title
string (Title)
Default: ""
text
string (Text)
Default: ""
Recipeid (string) or Recipeid (null) (Recipeid)

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "entryType": "breakfast",
  • "title": "",
  • "text": "",
  • "recipeId": "31545f76-b27f-4c7c-9faf-229771396df1"
}

Response samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "entryType": "breakfast",
  • "title": "",
  • "text": "",
  • "recipeId": "31545f76-b27f-4c7c-9faf-229771396df1",
  • "id": 0,
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "householdId": "b5d33c47-da83-44b4-b7bf-7ab3c5485f36",
  • "recipe": {
    }
}

Get Todays Meals

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Create Random Meal

create_random_meal is a route that provides the randomized functionality for mealplaners. It operates by following the rules set out in the household's mealplan settings. If no settings are set, it will return any random meal.

Refer to the mealplan settings routes for more information on how rules can be applied to the random meal selector.

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
date
required
string <date> (Date)
entryType
string (PlanEntryType)
Default: "dinner"
Enum: "breakfast" "lunch" "dinner" "side"

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "entryType": "breakfast"
}

Response samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "entryType": "breakfast",
  • "title": "",
  • "text": "",
  • "recipeId": "31545f76-b27f-4c7c-9faf-229771396df1",
  • "id": 0,
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "householdId": "b5d33c47-da83-44b4-b7bf-7ab3c5485f36",
  • "recipe": {
    }
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
integer (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "entryType": "breakfast",
  • "title": "",
  • "text": "",
  • "recipeId": "31545f76-b27f-4c7c-9faf-229771396df1",
  • "id": 0,
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "householdId": "b5d33c47-da83-44b4-b7bf-7ab3c5485f36",
  • "recipe": {
    }
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
integer (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
date
required
string <date> (Date)
entryType
string (PlanEntryType)
Default: "breakfast"
Enum: "breakfast" "lunch" "dinner" "side"
title
string (Title)
Default: ""
text
string (Text)
Default: ""
Recipeid (string) or Recipeid (null) (Recipeid)
id
required
integer (Id)
groupId
required
string <uuid> (Groupid)
userId
required
string <uuid> (Userid)

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "entryType": "breakfast",
  • "title": "",
  • "text": "",
  • "recipeId": "31545f76-b27f-4c7c-9faf-229771396df1",
  • "id": 0,
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Response samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "entryType": "breakfast",
  • "title": "",
  • "text": "",
  • "recipeId": "31545f76-b27f-4c7c-9faf-229771396df1",
  • "id": 0,
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "householdId": "b5d33c47-da83-44b4-b7bf-7ab3c5485f36",
  • "recipe": {
    }
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
integer (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "entryType": "breakfast",
  • "title": "",
  • "text": "",
  • "recipeId": "31545f76-b27f-4c7c-9faf-229771396df1",
  • "id": 0,
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "householdId": "b5d33c47-da83-44b4-b7bf-7ab3c5485f36",
  • "recipe": {
    }
}

Groups: Households

Get All Households

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Get One Household

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
household_slug
required
string (Household Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "groupId": "string",
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "preferences": {
    }
}

Groups: Self Service

Get Logged In User Group

Returns the Group Data for the Current User

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "preferences": {
    }
}

Get Group Members

Returns all users belonging to the current group

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Get Group Member

Returns a single user belonging to the current group

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
required
Username Or Id (string) or Username Or Id (string) (Username Or Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "groupId": "string",
  • "householdId": "string",
  • "username": "string",
  • "fullName": "string"
}

Get Group Preferences

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "privateGroup": true,
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "id": "string"
}

Update Group Preferences

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
privateGroup
boolean (Privategroup)
Default: true

Responses

Request samples

Content type
application/json
{
  • "privateGroup": true
}

Response samples

Content type
application/json
{
  • "privateGroup": true,
  • "groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
  • "id": "string"
}

Get Storage

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "usedStorageBytes": 0,
  • "usedStorageStr": "string",
  • "totalStorageBytes": 0,
  • "totalStorageStr": "string"
}

Groups: Migrations

Start Data Migration

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: multipart/form-data
required
add_migration_tag
boolean (Add Migration Tag)
Default: false
migration_type
required
string (SupportedMigrations)
Enum: "nextcloud" "chowdown" "copymethat" "paprika" "mealie_alpha" "tandoor" "plantoeat" "myrecipebox" "recipekeeper"
archive
required
string <binary> (Archive)

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "category": "backup",
  • "groupId": "string",
  • "name": "string",
  • "status": "in-progress",
  • "id": "string"
}

Groups: Reports

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
ReportCategory (string) or Report Type (null) (Report Type)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "timestamp": "2019-08-24T14:15:22Z",
  • "category": "backup",
  • "groupId": "string",
  • "name": "string",
  • "status": "in-progress",
  • "id": "string",
  • "entries": [ ]
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Groups: Multi Purpose Labels

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Search (string) or Search (null) (Search)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)
color
string (Color)
Default: "#959595"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "color": "#959595"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "color": "#959595",
  • "groupId": "string",
  • "id": "string"
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "color": "#959595",
  • "groupId": "string",
  • "id": "string"
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)
color
string (Color)
Default: "#959595"
groupId
required
string <uuid4> (Groupid)
id
required
string <uuid4> (Id)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "color": "#959595",
  • "groupId": "string",
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "color": "#959595",
  • "groupId": "string",
  • "id": "string"
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "color": "#959595",
  • "groupId": "string",
  • "id": "string"
}

Groups: Seeders

Seed Foods

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
locale
required
string (Locale)

Responses

Request samples

Content type
application/json
{
  • "locale": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Seed Labels

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
locale
required
string (Locale)

Responses

Request samples

Content type
application/json
{
  • "locale": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Seed Units

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
locale
required
string (Locale)

Responses

Request samples

Content type
application/json
{
  • "locale": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Recipe: Exports

Get Recipe Formats And Templates

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "json": [
    ],
  • "zip": [
    ],
  • "jinja2": [
    ]
}

Get Recipe Zip Token

Generates a recipe zip token to be used to download a recipe as a zip file

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

Get Recipe As Format

Parameters

template_name: The name of the template to use to use in the exports listed. Template type will automatically be set on the backend. Because of this, it's important that your templates have unique names. See available names and formats in the /api/recipes/exports endpoint.

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
query Parameters
template_name
required
string (Template Name)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get Recipe As Zip

Get a Recipe and Its Original Image as a Zip File

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
query Parameters
token
required
string (Token)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Recipe: CRUD

Test Parse Recipe Url

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
url
required
string (Url)
useOpenAI
boolean (Useopenai)
Default: false

Responses

Request samples

Content type
application/json
{
  • "url": "string",
  • "useOpenAI": false
}

Response samples

Content type
application/json
null

Create Recipe From Html Or Json

Takes in raw HTML or a https://schema.org/Recipe object as a JSON string and parses it like a URL

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
includeTags
boolean (Includetags)
Default: false
data
required
string (Data)

Responses

Request samples

Content type
application/json
{
  • "includeTags": false,
  • "data": "string"
}

Response samples

Content type
application/json
null

Parse Recipe Url

Takes in a URL and attempts to scrape data and load it into the database

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
includeTags
boolean (Includetags)
Default: false
url
required
string (Url)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
"string"

Parse Recipe Url Bulk

Takes in a URL and attempts to scrape data and load it into the database

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
required
Array of objects (Imports)

Responses

Request samples

Content type
application/json
{
  • "imports": [
    ]
}

Response samples

Content type
application/json
null

Create Recipe From Zip

Create recipe from archive

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: multipart/form-data
required
archive
required
string <binary> (Archive)

Responses

Response samples

Content type
application/json
null

Create Recipe From Image

Create a recipe from an image using OpenAI. Optionally specify a language for it to translate the recipe to.

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Translatelanguage (string) or Translatelanguage (null) (Translatelanguage)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: multipart/form-data
required
images
required
Array of strings <binary> (Images) [ items <binary > ]

Responses

Response samples

Content type
application/json
null

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
(Array of Categories (strings or strings)) or Categories (null) (Categories)
(Array of Tags (strings or strings)) or Tags (null) (Tags)
(Array of Tools (strings or strings)) or Tools (null) (Tools)
(Array of Foods (strings or strings)) or Foods (null) (Foods)
(Array of Households (strings or strings)) or Households (null) (Households)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
Cookbook (string) or Cookbook (string) or Cookbook (null) (Cookbook)
requireAllCategories
boolean (Requireallcategories)
Default: false
requireAllTags
boolean (Requirealltags)
Default: false
requireAllTools
boolean (Requirealltools)
Default: false
requireAllFoods
boolean (Requireallfoods)
Default: false
Search (string) or Search (null) (Search)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Takes in a JSON string and loads data into the database as a new entry

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
"string"

Update Many

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Array
Id (string) or Id (null) (Id)
userId
string <uuid4> (Userid)
householdId
string <uuid4> (Householdid)
groupId
string <uuid4> (Groupid)
Name (string) or Name (null) (Name)
slug
string (Slug)
Default: ""
Image (any) or Image (null) (Image)
recipeServings
number (Recipeservings)
Default: 0
recipeYieldQuantity
number (Recipeyieldquantity)
Default: 0
Recipeyield (string) or Recipeyield (null) (Recipeyield)
Totaltime (string) or Totaltime (null) (Totaltime)
Preptime (string) or Preptime (null) (Preptime)
Cooktime (string) or Cooktime (null) (Cooktime)
Performtime (string) or Performtime (null) (Performtime)
Description (string) or Description (null) (Description)
Default: ""
Array of Recipecategory (objects) or Recipecategory (null) (Recipecategory)
Default: []
Array of Tags (objects) or Tags (null) (Tags)
Default: []
Array of objects (Tools)
Default: []
Rating (number) or Rating (null) (Rating)
Orgurl (string) or Orgurl (null) (Orgurl)
Dateadded (string) or Dateadded (null) (Dateadded)
Dateupdated (string) or Dateupdated (null) (Dateupdated)
Createdat (string) or Createdat (null) (Createdat)
Update At (string) or Update At (null) (Update At)
Lastmade (string) or Lastmade (null) (Lastmade)
Array of objects (Recipeingredient)
Default: []
Array of Recipeinstructions (objects) or Recipeinstructions (null) (Recipeinstructions)
Default: []
Nutrition (object) or null
RecipeSettings (object) or null
Array of Assets (objects) or Assets (null) (Assets)
Default: []
Array of Notes (objects) or Notes (null) (Notes)
Default: []
Extras (object) or Extras (null) (Extras)
Default: {}
Array of Comments (objects) or Comments (null) (Comments)
Default: []

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
null

Patch Many

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Array
Id (string) or Id (null) (Id)
userId
string <uuid4> (Userid)
householdId
string <uuid4> (Householdid)
groupId
string <uuid4> (Groupid)
Name (string) or Name (null) (Name)
slug
string (Slug)
Default: ""
Image (any) or Image (null) (Image)
recipeServings
number (Recipeservings)
Default: 0
recipeYieldQuantity
number (Recipeyieldquantity)
Default: 0
Recipeyield (string) or Recipeyield (null) (Recipeyield)
Totaltime (string) or Totaltime (null) (Totaltime)
Preptime (string) or Preptime (null) (Preptime)
Cooktime (string) or Cooktime (null) (Cooktime)
Performtime (string) or Performtime (null) (Performtime)
Description (string) or Description (null) (Description)
Default: ""
Array of Recipecategory (objects) or Recipecategory (null) (Recipecategory)
Default: []
Array of Tags (objects) or Tags (null) (Tags)
Default: []
Array of objects (Tools)
Default: []
Rating (number) or Rating (null) (Rating)
Orgurl (string) or Orgurl (null) (Orgurl)
Dateadded (string) or Dateadded (null) (Dateadded)
Dateupdated (string) or Dateupdated (null) (Dateupdated)
Createdat (string) or Createdat (null) (Createdat)
Update At (string) or Update At (null) (Update At)
Lastmade (string) or Lastmade (null) (Lastmade)
Array of objects (Recipeingredient)
Default: []
Array of Recipeinstructions (objects) or Recipeinstructions (null) (Recipeinstructions)
Default: []
Nutrition (object) or null
RecipeSettings (object) or null
Array of Assets (objects) or Assets (null) (Assets)
Default: []
Array of Notes (objects) or Notes (null) (Notes)
Default: []
Extras (object) or Extras (null) (Extras)
Default: {}
Array of Comments (objects) or Comments (null) (Comments)
Default: []

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
null

Suggest Recipes

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Array of Foods (strings) or Foods (null) (Foods)
Array of Tools (strings) or Tools (null) (Tools)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
limit
integer (Limit)
Default: 10
maxMissingFoods
integer (Maxmissingfoods)
Default: 5
maxMissingTools
integer (Maxmissingtools)
Default: 5
includeFoodsOnHand
boolean (Includefoodsonhand)
Default: true
includeToolsOnHand
boolean (Includetoolsonhand)
Default: true
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get One

Takes in a recipe's slug or id and returns all data for a recipe

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)

A recipe's slug or id

header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "userId": "string",
  • "householdId": "string",
  • "groupId": "string",
  • "name": "string",
  • "slug": "",
  • "image": { },
  • "recipeServings": 0,
  • "recipeYieldQuantity": 0,
  • "recipeYield": "string",
  • "totalTime": "string",
  • "prepTime": "string",
  • "cookTime": "string",
  • "performTime": "string",
  • "description": "",
  • "recipeCategory": [ ],
  • "tags": [ ],
  • "tools": [ ],
  • "rating": 0,
  • "orgURL": "string",
  • "dateAdded": "2019-08-24",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lastMade": "2019-08-24T14:15:22Z",
  • "recipeIngredient": [ ],
  • "recipeInstructions": [ ],
  • "nutrition": {
    },
  • "settings": {
    },
  • "assets": [ ],
  • "notes": [ ],
  • "extras": { },
  • "comments": [ ]
}

Update One

Updates a recipe by existing slug and data.

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Id (string) or Id (null) (Id)
userId
string <uuid4> (Userid)
householdId
string <uuid4> (Householdid)
groupId
string <uuid4> (Groupid)
Name (string) or Name (null) (Name)
slug
string (Slug)
Default: ""
Image (any) or Image (null) (Image)
recipeServings
number (Recipeservings)
Default: 0
recipeYieldQuantity
number (Recipeyieldquantity)
Default: 0
Recipeyield (string) or Recipeyield (null) (Recipeyield)
Totaltime (string) or Totaltime (null) (Totaltime)
Preptime (string) or Preptime (null) (Preptime)
Cooktime (string) or Cooktime (null) (Cooktime)
Performtime (string) or Performtime (null) (Performtime)
Description (string) or Description (null) (Description)
Default: ""
Array of Recipecategory (objects) or Recipecategory (null) (Recipecategory)
Default: []
Array of Tags (objects) or Tags (null) (Tags)
Default: []
Array of objects (Tools)
Default: []
Rating (number) or Rating (null) (Rating)
Orgurl (string) or Orgurl (null) (Orgurl)
Dateadded (string) or Dateadded (null) (Dateadded)
Dateupdated (string) or Dateupdated (null) (Dateupdated)
Createdat (string) or Createdat (null) (Createdat)
Update At (string) or Update At (null) (Update At)
Lastmade (string) or Lastmade (null) (Lastmade)
Array of objects (Recipeingredient)
Default: []
Array of Recipeinstructions (objects) or Recipeinstructions (null) (Recipeinstructions)
Default: []
Nutrition (object) or null
RecipeSettings (object) or null
Array of Assets (objects) or Assets (null) (Assets)
Default: []
Array of Notes (objects) or Notes (null) (Notes)
Default: []
Extras (object) or Extras (null) (Extras)
Default: {}
Array of Comments (objects) or Comments (null) (Comments)
Default: []

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "userId": "string",
  • "householdId": "string",
  • "groupId": "string",
  • "name": "string",
  • "slug": "",
  • "image": { },
  • "recipeServings": 0,
  • "recipeYieldQuantity": 0,
  • "recipeYield": "string",
  • "totalTime": "string",
  • "prepTime": "string",
  • "cookTime": "string",
  • "performTime": "string",
  • "description": "",
  • "recipeCategory": [ ],
  • "tags": [ ],
  • "tools": [ ],
  • "rating": 0,
  • "orgURL": "string",
  • "dateAdded": "2019-08-24",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "update_at": "2019-08-24T14:15:22Z",
  • "lastMade": "2019-08-24T14:15:22Z",
  • "recipeIngredient": [ ],
  • "recipeInstructions": [ ],
  • "nutrition": {
    },
  • "settings": {
    },
  • "assets": [ ],
  • "notes": [ ],
  • "extras": { },
  • "comments": [ ]
}

Response samples

Content type
application/json
null

Patch One

Updates a recipe by existing slug and data.

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Id (string) or Id (null) (Id)
userId
string <uuid4> (Userid)
householdId
string <uuid4> (Householdid)
groupId
string <uuid4> (Groupid)
Name (string) or Name (null) (Name)
slug
string (Slug)
Default: ""
Image (any) or Image (null) (Image)
recipeServings
number (Recipeservings)
Default: 0
recipeYieldQuantity
number (Recipeyieldquantity)
Default: 0
Recipeyield (string) or Recipeyield (null) (Recipeyield)
Totaltime (string) or Totaltime (null) (Totaltime)
Preptime (string) or Preptime (null) (Preptime)
Cooktime (string) or Cooktime (null) (Cooktime)
Performtime (string) or Performtime (null) (Performtime)
Description (string) or Description (null) (Description)
Default: ""
Array of Recipecategory (objects) or Recipecategory (null) (Recipecategory)
Default: []
Array of Tags (objects) or Tags (null) (Tags)
Default: []
Array of objects (Tools)
Default: []
Rating (number) or Rating (null) (Rating)
Orgurl (string) or Orgurl (null) (Orgurl)
Dateadded (string) or Dateadded (null) (Dateadded)
Dateupdated (string) or Dateupdated (null) (Dateupdated)
Createdat (string) or Createdat (null) (Createdat)
Update At (string) or Update At (null) (Update At)
Lastmade (string) or Lastmade (null) (Lastmade)
Array of objects (Recipeingredient)
Default: []
Array of Recipeinstructions (objects) or Recipeinstructions (null) (Recipeinstructions)
Default: []
Nutrition (object) or null
RecipeSettings (object) or null
Array of Assets (objects) or Assets (null) (Assets)
Default: []
Array of Notes (objects) or Notes (null) (Notes)
Default: []
Extras (object) or Extras (null) (Extras)
Default: {}
Array of Comments (objects) or Comments (null) (Comments)
Default: []

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "userId": "string",
  • "householdId": "string",
  • "groupId": "string",
  • "name": "string",
  • "slug": "",
  • "image": { },
  • "recipeServings": 0,
  • "recipeYieldQuantity": 0,
  • "recipeYield": "string",
  • "totalTime": "string",
  • "prepTime": "string",
  • "cookTime": "string",
  • "performTime": "string",
  • "description": "",
  • "recipeCategory": [ ],
  • "tags": [ ],
  • "tools": [ ],
  • "rating": 0,
  • "orgURL": "string",
  • "dateAdded": "2019-08-24",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "update_at": "2019-08-24T14:15:22Z",
  • "lastMade": "2019-08-24T14:15:22Z",
  • "recipeIngredient": [ ],
  • "recipeInstructions": [ ],
  • "nutrition": {
    },
  • "settings": {
    },
  • "assets": [ ],
  • "notes": [ ],
  • "extras": { },
  • "comments": [ ]
}

Response samples

Content type
application/json
null

Delete One

Deletes a recipe by slug

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Duplicate One

Duplicates a recipe with a new custom name if given

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Name (string) or Name (null) (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "userId": "string",
  • "householdId": "string",
  • "groupId": "string",
  • "name": "string",
  • "slug": "",
  • "image": { },
  • "recipeServings": 0,
  • "recipeYieldQuantity": 0,
  • "recipeYield": "string",
  • "totalTime": "string",
  • "prepTime": "string",
  • "cookTime": "string",
  • "performTime": "string",
  • "description": "",
  • "recipeCategory": [ ],
  • "tags": [ ],
  • "tools": [ ],
  • "rating": 0,
  • "orgURL": "string",
  • "dateAdded": "2019-08-24",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lastMade": "2019-08-24T14:15:22Z",
  • "recipeIngredient": [ ],
  • "recipeInstructions": [ ],
  • "nutrition": {
    },
  • "settings": {
    },
  • "assets": [ ],
  • "notes": [ ],
  • "extras": { },
  • "comments": [ ]
}

Update Last Made

Update a recipe's last made timestamp

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
timestamp
required
string <date-time> (Timestamp)

Responses

Request samples

Content type
application/json
{
  • "timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
null

Scrape Image Url

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
includeTags
boolean (Includetags)
Default: false
url
required
string (Url)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
null

Update Recipe Image

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: multipart/form-data
required
image
required
string <binary> (Image)
extension
required
string (Extension)

Responses

Response samples

Content type
application/json
{
  • "image": "string"
}

Upload Recipe Asset

Upload a file to store as a recipe asset

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: multipart/form-data
required
name
required
string (Name)
icon
required
string (Icon)
extension
required
string (Extension)
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "icon": "string",
  • "fileName": "string"
}

Recipe: Images and Assets

Scrape Image Url

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
includeTags
boolean (Includetags)
Default: false
url
required
string (Url)

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
null

Update Recipe Image

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: multipart/form-data
required
image
required
string <binary> (Image)
extension
required
string (Extension)

Responses

Response samples

Content type
application/json
{
  • "image": "string"
}

Upload Recipe Asset

Upload a file to store as a recipe asset

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: multipart/form-data
required
name
required
string (Name)
icon
required
string (Icon)
extension
required
string (Extension)
file
required
string <binary> (File)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "icon": "string",
  • "fileName": "string"
}

Get Recipe Img

Takes in a recipe id, returns the static image. This route is proxied in the docker image and should not hit the API in production

path Parameters
recipe_id
required
string (Recipe Id)
file_name
required
string (ImageType)
Enum: "original.webp" "min-original.webp" "tiny-original.webp"

Responses

Response samples

Content type
application/json
null

Get Recipe Timeline Event Img

Takes in a recipe id and event timeline id, returns the static image. This route is proxied in the docker image and should not hit the API in production

path Parameters
recipe_id
required
string (Recipe Id)
timeline_event_id
required
string (Timeline Event Id)
file_name
required
string (ImageType)
Enum: "original.webp" "min-original.webp" "tiny-original.webp"

Responses

Response samples

Content type
application/json
null

Get Recipe Asset

Returns a recipe asset

path Parameters
recipe_id
required
string <uuid4> (Recipe Id)
file_name
required
string (File Name)

Responses

Response samples

Content type
application/json
null

Get User Image

Takes in a recipe slug, returns the static image. This route is proxied in the docker image and should not hit the API in production

path Parameters
user_id
required
string <uuid4> (User Id)
file_name
required
string (File Name)

Responses

Response samples

Content type
application/json
{
  • "detail": [
    ]
}

Get Validation Text

Responses

Recipe: Comments

Get Recipe Comments

Get all comments for a recipe

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
slug
required
string (Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
recipeId
required
string <uuid4> (Recipeid)
text
required
string (Text)

Responses

Request samples

Content type
application/json
{
  • "recipeId": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "recipeId": "string",
  • "text": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "userId": "string",
  • "user": {
    }
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "recipeId": "string",
  • "text": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "userId": "string",
  • "user": {
    }
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
id
required
string <uuid4> (Id)
text
required
string (Text)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "text": "string"
}

Response samples

Content type
application/json
{
  • "recipeId": "string",
  • "text": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "userId": "string",
  • "user": {
    }
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Recipe: Bulk Actions

Bulk Tag Recipes

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
recipes
required
Array of strings (Recipes)
required
Array of objects (Tags)

Responses

Request samples

Content type
application/json
{
  • "recipes": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
null

Bulk Settings Recipes

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
recipes
required
Array of strings (Recipes)
required
object (RecipeSettings)

Responses

Request samples

Content type
application/json
{
  • "recipes": [
    ],
  • "settings": {
    }
}

Response samples

Content type
application/json
null

Bulk Categorize Recipes

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
recipes
required
Array of strings (Recipes)
required
Array of objects (Categories)

Responses

Request samples

Content type
application/json
{
  • "recipes": [
    ],
  • "categories": [
    ]
}

Response samples

Content type
application/json
null

Bulk Delete Recipes

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
recipes
required
Array of strings (Recipes)

Responses

Request samples

Content type
application/json
{
  • "recipes": [
    ]
}

Response samples

Content type
application/json
null

Bulk Export Recipes

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
recipes
required
Array of strings (Recipes)
exportType
string (ExportTypes)
Default: "json"
Value: "json"

Responses

Request samples

Content type
application/json
{
  • "recipes": [
    ],
  • "exportType": "json"
}

Response samples

Content type
application/json
null

Get Exported Data

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Exported Data Token

Returns a token to download a file

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
path
required
string <path> (Path)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Purge Export Data

Remove all exports data, including items on disk without database entry

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Recipe: Shared

Get Shared Recipe

path Parameters
token_id
required
string <uuid4> (Token Id)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "userId": "string",
  • "householdId": "string",
  • "groupId": "string",
  • "name": "string",
  • "slug": "",
  • "image": { },
  • "recipeServings": 0,
  • "recipeYieldQuantity": 0,
  • "recipeYield": "string",
  • "totalTime": "string",
  • "prepTime": "string",
  • "cookTime": "string",
  • "performTime": "string",
  • "description": "",
  • "recipeCategory": [ ],
  • "tags": [ ],
  • "tools": [ ],
  • "rating": 0,
  • "orgURL": "string",
  • "dateAdded": "2019-08-24",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lastMade": "2019-08-24T14:15:22Z",
  • "recipeIngredient": [ ],
  • "recipeInstructions": [ ],
  • "nutrition": {
    },
  • "settings": {
    },
  • "assets": [ ],
  • "notes": [ ],
  • "extras": { },
  • "comments": [ ]
}

Recipe: Timeline

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
recipeId
required
string <uuid4> (Recipeid)
Userid (string) or Userid (null) (Userid)
subject
required
string (Subject)
eventType
required
string (TimelineEventType)
Enum: "system" "info" "comment"
Eventmessage (string) or Eventmessage (null) (Eventmessage)
TimelineEventImage (string) or null
Default: "does not have image"
timestamp
string <date-time> (Timestamp)

Responses

Request samples

Content type
application/json
{
  • "recipeId": "string",
  • "userId": "string",
  • "subject": "string",
  • "eventType": "system",
  • "eventMessage": "string",
  • "image": "does not have image",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "recipeId": "string",
  • "userId": "string",
  • "subject": "string",
  • "eventType": "system",
  • "eventMessage": "string",
  • "image": "does not have image",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "groupId": "string",
  • "householdId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "recipeId": "string",
  • "userId": "string",
  • "subject": "string",
  • "eventType": "system",
  • "eventMessage": "string",
  • "image": "does not have image",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "groupId": "string",
  • "householdId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
subject
required
string (Subject)
Eventmessage (string) or Eventmessage (null) (Eventmessage)
TimelineEventImage (string) or null

Responses

Request samples

Content type
application/json
{
  • "subject": "string",
  • "eventMessage": "string",
  • "image": "has image"
}

Response samples

Content type
application/json
{
  • "recipeId": "string",
  • "userId": "string",
  • "subject": "string",
  • "eventType": "system",
  • "eventMessage": "string",
  • "image": "does not have image",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "groupId": "string",
  • "householdId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "recipeId": "string",
  • "userId": "string",
  • "subject": "string",
  • "eventType": "system",
  • "eventMessage": "string",
  • "image": "does not have image",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "groupId": "string",
  • "householdId": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update Event Image

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: multipart/form-data
required
image
required
string <binary> (Image)
extension
required
string (Extension)

Responses

Response samples

Content type
application/json
{
  • "image": "string"
}

Organizer: Categories

Get All

Returns a list of available categories in the database

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Search (string) or Search (null) (Search)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Creates a Category in the database

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
null

Get All Empty

Returns a list of categories that do not contain any recipes

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get One

Returns a list of recipes associated with the provided category.

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "slug": "string",
  • "name": "string"
}

Update One

Updates an existing Tag in the database

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "slug": "string",
  • "name": "string"
}

Delete One

Removes a recipe category from the database. Deleting a category does not impact a recipe. The category will be removed from any recipes that contain it

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Get One By Slug

Returns a category object with the associated recieps relating to the category

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
category_slug
required
string (Category Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Organizer: Tags

Get All

Returns a list of available tags in the database

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Search (string) or Search (null) (Search)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Creates a Tag in the database

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
null

Get Empty Tags

Returns a list of tags that do not contain any recipes

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Get One

Returns a list of recipes associated with the provided tag.

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "recipes": [ ]
}

Update One

Updates an existing Tag in the database

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "recipes": [ ]
}

Delete Recipe Tag

Removes a recipe tag from the database. Deleting a tag does not impact a recipe. The tag will be removed from any recipes that contain it

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Get One By Slug

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
tag_slug
required
string (Tag Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "recipes": [ ]
}

Organizer: Tools

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Search (string) or Search (null) (Search)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)
householdsWithTool
Array of strings (Householdswithtool)
Default: []

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "householdsWithTool": [ ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "slug": "string",
  • "householdsWithTool": [ ]
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "slug": "string",
  • "householdsWithTool": [ ]
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name)
householdsWithTool
Array of strings (Householdswithtool)
Default: []

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "householdsWithTool": [ ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "slug": "string",
  • "householdsWithTool": [ ]
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "slug": "string",
  • "householdsWithTool": [ ]
}

Get One By Slug

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
tool_slug
required
string (Tool Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "householdsWithTool": [ ],
  • "id": "string",
  • "slug": "string",
  • "recipes": [ ]
}

Shared: Recipes

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Recipe Id (string) or Recipe Id (null) (Recipe Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
recipeId
required
string <uuid4> (Recipeid)
expiresAt
string <date-time> (Expiresat)

Responses

Request samples

Content type
application/json
{
  • "recipeId": "string",
  • "expiresAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "recipeId": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "recipe": {
    }
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "recipeId": "string",
  • "expiresAt": "2019-08-24T14:15:22Z",
  • "groupId": "string",
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "recipe": {
    }
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
required
Item Id (string) or Item Id (null) (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
null

Recipe: Ingredient Parser

Parse Ingredient

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
parser
string (RegisteredParser)
Default: "nlp"
Enum: "nlp" "brute" "openai"
ingredient
required
string (Ingredient)

Responses

Request samples

Content type
application/json
{
  • "parser": "nlp",
  • "ingredient": "string"
}

Response samples

Content type
application/json
{
  • "input": "string",
  • "confidence": {
    },
  • "ingredient": {
    }
}

Parse Ingredients

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
parser
string (RegisteredParser)
Default: "nlp"
Enum: "nlp" "brute" "openai"
ingredients
required
Array of strings (Ingredients)

Responses

Request samples

Content type
application/json
{
  • "parser": "nlp",
  • "ingredients": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Recipes: Foods

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Search (string) or Search (null) (Search)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Id (string) or Id (null) (Id)
name
required
string (Name)
Pluralname (string) or Pluralname (null) (Pluralname)
description
string (Description)
Default: ""
Extras (object) or Extras (null) (Extras)
Default: {}
Labelid (string) or Labelid (null) (Labelid)
Array of objects (Aliases)
Default: []
householdsWithIngredientFood
Array of strings (Householdswithingredientfood)
Default: []

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "labelId": "string",
  • "aliases": [ ],
  • "householdsWithIngredientFood": [ ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "labelId": "string",
  • "aliases": [ ],
  • "householdsWithIngredientFood": [ ],
  • "label": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Merge One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
fromFood
required
string <uuid4> (Fromfood)
toFood
required
string <uuid4> (Tofood)

Responses

Request samples

Content type
application/json
{
  • "fromFood": "string",
  • "toFood": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "labelId": "string",
  • "aliases": [ ],
  • "householdsWithIngredientFood": [ ],
  • "label": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Id (string) or Id (null) (Id)
name
required
string (Name)
Pluralname (string) or Pluralname (null) (Pluralname)
description
string (Description)
Default: ""
Extras (object) or Extras (null) (Extras)
Default: {}
Labelid (string) or Labelid (null) (Labelid)
Array of objects (Aliases)
Default: []
householdsWithIngredientFood
Array of strings (Householdswithingredientfood)
Default: []

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "labelId": "string",
  • "aliases": [ ],
  • "householdsWithIngredientFood": [ ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "labelId": "string",
  • "aliases": [ ],
  • "householdsWithIngredientFood": [ ],
  • "label": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "labelId": "string",
  • "aliases": [ ],
  • "householdsWithIngredientFood": [ ],
  • "label": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Recipes: Units

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Search (string) or Search (null) (Search)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Id (string) or Id (null) (Id)
name
required
string (Name)
Pluralname (string) or Pluralname (null) (Pluralname)
description
string (Description)
Default: ""
Extras (object) or Extras (null) (Extras)
Default: {}
fraction
boolean (Fraction)
Default: true
abbreviation
string (Abbreviation)
Default: ""
Pluralabbreviation (string) or Pluralabbreviation (null) (Pluralabbreviation)
Default: ""
useAbbreviation
boolean (Useabbreviation)
Default: false
Array of objects (Aliases)
Default: []

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "fraction": true,
  • "abbreviation": "",
  • "pluralAbbreviation": "",
  • "useAbbreviation": false,
  • "aliases": [ ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "fraction": true,
  • "abbreviation": "",
  • "pluralAbbreviation": "",
  • "useAbbreviation": false,
  • "aliases": [ ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Merge One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
fromUnit
required
string <uuid4> (Fromunit)
toUnit
required
string <uuid4> (Tounit)

Responses

Request samples

Content type
application/json
{
  • "fromUnit": "string",
  • "toUnit": "string"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "fraction": true,
  • "abbreviation": "",
  • "pluralAbbreviation": "",
  • "useAbbreviation": false,
  • "aliases": [ ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Id (string) or Id (null) (Id)
name
required
string (Name)
Pluralname (string) or Pluralname (null) (Pluralname)
description
string (Description)
Default: ""
Extras (object) or Extras (null) (Extras)
Default: {}
fraction
boolean (Fraction)
Default: true
abbreviation
string (Abbreviation)
Default: ""
Pluralabbreviation (string) or Pluralabbreviation (null) (Pluralabbreviation)
Default: ""
useAbbreviation
boolean (Useabbreviation)
Default: false
Array of objects (Aliases)
Default: []

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "fraction": true,
  • "abbreviation": "",
  • "pluralAbbreviation": "",
  • "useAbbreviation": false,
  • "aliases": [ ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "fraction": true,
  • "abbreviation": "",
  • "pluralAbbreviation": "",
  • "useAbbreviation": false,
  • "aliases": [ ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "fraction": true,
  • "abbreviation": "",
  • "pluralAbbreviation": "",
  • "useAbbreviation": false,
  • "aliases": [ ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Admin: About

Get App Info

Get general application information

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "production": true,
  • "version": "string",
  • "demoStatus": true,
  • "allowSignup": true,
  • "defaultGroupSlug": "string",
  • "defaultHouseholdSlug": "string",
  • "enableOidc": true,
  • "oidcRedirect": true,
  • "oidcProviderName": "string",
  • "enableOpenai": true,
  • "enableOpenaiImageServices": true,
  • "versionLatest": "string",
  • "apiPort": 0,
  • "apiDocs": true,
  • "dbType": "string",
  • "dbUrl": "string",
  • "defaultGroup": "string",
  • "defaultHousehold": "string",
  • "buildId": "string",
  • "recipeScraperVersion": "string"
}

Get App Statistics

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "totalRecipes": 0,
  • "totalUsers": 0,
  • "totalHouseholds": 0,
  • "totalGroups": 0,
  • "uncategorizedRecipes": 0,
  • "untaggedRecipes": 0
}

Check App Config

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "emailReady": true,
  • "ldapReady": true,
  • "oidcReady": true,
  • "enableOpenai": true,
  • "baseUrlSet": true,
  • "isUpToDate": true
}

Admin: Manage Users

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Id (string) or Id (null) (Id)
username
required
string (Username)
fullName
required
string (Fullname)
email
required
string (Email)
authMethod
string (AuthMethod)
Default: "Mealie"
Enum: "Mealie" "LDAP" "OIDC"
admin
boolean (Admin)
Default: false
Group (string) or Group (null) (Group)
Household (string) or Household (null) (Household)
advanced
boolean (Advanced)
Default: false
canInvite
boolean (Caninvite)
Default: false
canManage
boolean (Canmanage)
Default: false
canManageHousehold
boolean (Canmanagehousehold)
Default: false
canOrganize
boolean (Canorganize)
Default: false
password
required
string (Password)

Responses

Request samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Response samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Unlock Users

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
force
boolean (Force)
Default: false
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "unlocked": 0
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
id
required
string <uuid4> (Id)
Username (string) or Username (null) (Username)
Fullname (string) or Fullname (null) (Fullname)
email
required
string (Email)
authMethod
string (AuthMethod)
Default: "Mealie"
Enum: "Mealie" "LDAP" "OIDC"
admin
boolean (Admin)
Default: false
group
required
string (Group)
household
required
string (Household)
advanced
boolean (Advanced)
Default: false
canInvite
boolean (Caninvite)
Default: false
canManage
boolean (Canmanage)
Default: false
canManageHousehold
boolean (Canmanagehousehold)
Default: false
canOrganize
boolean (Canorganize)
Default: false
groupId
required
string <uuid4> (Groupid)
groupSlug
required
string (Groupslug)
householdId
required
string <uuid4> (Householdid)
householdSlug
required
string (Householdslug)
Array of Tokens (objects) or Tokens (null) (Tokens)
cacheKey
required
string (Cachekey)

Responses

Request samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Response samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "admin": "false",
  • "email": "changeme@example.com",
  • "fullName": "Change Me",
  • "group": "Home",
  • "household": "Family",
  • "username": "ChangeMe"
}

Generate Token

Generates a reset token and returns it. This is an authenticated endpoint

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
email
required
string (Email)

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "token": "string"
}

Admin: Manage Households

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
Groupid (string) or Groupid (null) (Groupid)
name
required
string (Name) non-empty

Responses

Request samples

Content type
application/json
{
  • "groupId": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "groupId": "string",
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "preferences": {
    },
  • "group": "string",
  • "users": [
    ],
  • "webhooks": [ ]
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "groupId": "string",
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "preferences": {
    },
  • "group": "string",
  • "users": [
    ],
  • "webhooks": [ ]
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
groupId
required
string <uuid4> (Groupid)
name
required
string (Name) non-empty
id
required
string <uuid4> (Id)
UpdateHouseholdPreferences (object) or null

Responses

Request samples

Content type
application/json
{
  • "groupId": "string",
  • "name": "string",
  • "id": "string",
  • "preferences": {
    }
}

Response samples

Content type
application/json
{
  • "groupId": "string",
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "preferences": {
    },
  • "group": "string",
  • "users": [
    ],
  • "webhooks": [ ]
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "groupId": "string",
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "preferences": {
    },
  • "group": "string",
  • "users": [
    ],
  • "webhooks": [ ]
}

Admin: Manage Groups

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
name
required
string (Name) non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "categories": [ ],
  • "webhooks": [ ],
  • "households": [
    ],
  • "users": [
    ],
  • "preferences": {
    }
}

Get One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "categories": [ ],
  • "webhooks": [ ],
  • "households": [
    ],
  • "users": [
    ],
  • "preferences": {
    }
}

Update One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
id
required
string <uuid4> (Id)
name
required
string (Name)
UpdateGroupPreferences (object) or null

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "preferences": {
    }
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "categories": [ ],
  • "webhooks": [ ],
  • "households": [
    ],
  • "users": [
    ],
  • "preferences": {
    }
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
item_id
required
string <uuid4> (Item Id)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "categories": [ ],
  • "webhooks": [ ],
  • "households": [
    ],
  • "users": [
    ],
  • "preferences": {
    }
}

Admin: Email

Check Email Config

Get general application information

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "ready": true
}

Send Test Email

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: application/json
required
email
required
string (Email)

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "error": "string"
}

Admin: Backups

Get All

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "imports": [
    ],
  • "templates": [
    ]
}

Create One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Get One

Returns a token to download a file

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
file_name
required
string (File Name)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "fileToken": "string"
}

Delete One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
file_name
required
string (File Name)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Upload One

Upload a .zip File to later be imported into Mealie

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: multipart/form-data
required
archive
required
string <binary> (Archive)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Import One

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
path Parameters
file_name
required
string (File Name)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Admin: Maintenance

Get Maintenance Summary

Get the maintenance summary

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "dataDirSize": "string",
  • "cleanableImages": 0,
  • "cleanableDirs": 0
}

Get Storage Details

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "tempDirSize": "string",
  • "backupsDirSize": "string",
  • "groupsDirSize": "string",
  • "recipesDirSize": "string",
  • "userDirSize": "string"
}

Clean Images

Purges all the images from the filesystem that aren't .webp

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Clean Temp

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Clean Recipe Folders

Deletes all the recipe folders that don't have names that are valid UUIDs

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "error": false
}

Admin: Debug

Debug Openai

Authorizations:
OAuth2PasswordBearerOAuth2PasswordBearer
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)
Request Body schema: multipart/form-data
Image (string) or Image (null) (Image)

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "response": "string"
}

Explore: Foods

Get All

path Parameters
group_slug
required
string (Group Slug)
query Parameters
Search (string) or Search (null) (Search)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Get One

path Parameters
item_id
required
string <uuid4> (Item Id)
group_slug
required
string (Group Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "pluralName": "string",
  • "description": "",
  • "extras": { },
  • "labelId": "string",
  • "aliases": [ ],
  • "householdsWithIngredientFood": [ ],
  • "label": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Explore: Households

Get All

path Parameters
group_slug
required
string (Group Slug)
query Parameters
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Get Household

path Parameters
household_slug
required
string (Household Slug)
group_slug
required
string (Group Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "groupId": "string",
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "preferences": {
    }
}

Explore: Categories

Get All

path Parameters
group_slug
required
string (Group Slug)
query Parameters
Search (string) or Search (null) (Search)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Get One

path Parameters
item_id
required
string <uuid4> (Item Id)
group_slug
required
string (Group Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "id": "string",
  • "slug": "string",
  • "groupId": "string"
}

Explore: Tags

Get All

path Parameters
group_slug
required
string (Group Slug)
query Parameters
Search (string) or Search (null) (Search)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Get One

path Parameters
item_id
required
string <uuid4> (Item Id)
group_slug
required
string (Group Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "groupId": "string",
  • "id": "string",
  • "slug": "string"
}

Explore: Tools

Get All

path Parameters
group_slug
required
string (Group Slug)
query Parameters
Search (string) or Search (null) (Search)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Get One

path Parameters
item_id
required
string <uuid4> (Item Id)
group_slug
required
string (Group Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "householdsWithTool": [ ],
  • "id": "string",
  • "slug": "string"
}

Explore: Cookbooks

Get All

path Parameters
group_slug
required
string (Group Slug)
query Parameters
Search (string) or Search (null) (Search)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Get One

path Parameters
required
Item Id (string) or Item Id (string) (Item Id)
group_slug
required
string (Group Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "",
  • "slug": "string",
  • "position": 1,
  • "public": false,
  • "queryFilterString": "",
  • "groupId": "string",
  • "householdId": "string",
  • "id": "string",
  • "queryFilter": {
    },
  • "recipes": [
    ]
}

Explore: Recipes

Get All

path Parameters
group_slug
required
string (Group Slug)
query Parameters
(Array of Categories (strings or strings)) or Categories (null) (Categories)
(Array of Tags (strings or strings)) or Tags (null) (Tags)
(Array of Tools (strings or strings)) or Tools (null) (Tools)
(Array of Foods (strings or strings)) or Foods (null) (Foods)
(Array of Households (strings or strings)) or Households (null) (Households)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
page
integer (Page)
Default: 1
perPage
integer (Perpage)
Default: 50
Cookbook (string) or Cookbook (string) or Cookbook (null) (Cookbook)
requireAllCategories
boolean (Requireallcategories)
Default: false
requireAllTags
boolean (Requirealltags)
Default: false
requireAllTools
boolean (Requirealltools)
Default: false
requireAllFoods
boolean (Requireallfoods)
Default: false
Search (string) or Search (null) (Search)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "page": 1,
  • "per_page": 10,
  • "total": 0,
  • "total_pages": 0,
  • "items": [
    ],
  • "next": "string",
  • "previous": "string"
}

Suggest Recipes

path Parameters
group_slug
required
string (Group Slug)
query Parameters
Array of Foods (strings) or Foods (null) (Foods)
Array of Tools (strings) or Tools (null) (Tools)
Orderby (string) or Orderby (null) (Orderby)
OrderByNullPosition (string) or Orderbynullposition (null) (Orderbynullposition)
orderDirection
string (OrderDirection)
Default: "desc"
Enum: "asc" "desc"
Queryfilter (string) or Queryfilter (null) (Queryfilter)
Paginationseed (string) or Paginationseed (null) (Paginationseed)
limit
integer (Limit)
Default: 10
maxMissingFoods
integer (Maxmissingfoods)
Default: 5
maxMissingTools
integer (Maxmissingtools)
Default: 5
includeFoodsOnHand
boolean (Includefoodsonhand)
Default: true
includeToolsOnHand
boolean (Includetoolsonhand)
Default: true
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get Recipe

path Parameters
recipe_slug
required
string (Recipe Slug)
group_slug
required
string (Group Slug)
header Parameters
Accept-Language (string) or Accept-Language (null) (Accept-Language)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "userId": "string",
  • "householdId": "string",
  • "groupId": "string",
  • "name": "string",
  • "slug": "",
  • "image": { },
  • "recipeServings": 0,
  • "recipeYieldQuantity": 0,
  • "recipeYield": "string",
  • "totalTime": "string",
  • "prepTime": "string",
  • "cookTime": "string",
  • "performTime": "string",
  • "description": "",
  • "recipeCategory": [ ],
  • "tags": [ ],
  • "tools": [ ],
  • "rating": 0,
  • "orgURL": "string",
  • "dateAdded": "2019-08-24",
  • "dateUpdated": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "lastMade": "2019-08-24T14:15:22Z",
  • "recipeIngredient": [ ],
  • "recipeInstructions": [ ],
  • "nutrition": {
    },
  • "settings": {
    },
  • "assets": [ ],
  • "notes": [ ],
  • "extras": { },
  • "comments": [ ]
}

Utils

Download File

Uses a file token obtained by an active user to retrieve a file from the operating system.

query Parameters
Token (string) or Token (null) (Token)

Responses

Response samples

Content type
application/json
null