Mealie

Mealie Households: Event Notifications API

The Households: Event Notifications API from Mealie — 3 operation(s) for households: event notifications.

GitHub OpenAPI

Operations 6

GET /api/households/events/notifications Get All #
POST /api/households/events/notifications Create One #
GET /api/households/events/notifications/{item_id} Get One #
PUT /api/households/events/notifications/{item_id} Update One #
DELETE /api/households/events/notifications/{item_id} Delete One #
POST /api/households/events/notifications/{item_id}/test Test Notification #

Documentation

📖
Documentation
https://docs.mealie.io/documentation/getting-started/api-usage/
📖
APIReference
https://demo.mealie.io/docs
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/mealie/refs/heads/main/authentication/mealie-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/mealie/refs/heads/main/rate-limits/mealie-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mealie/refs/heads/main/openapi/mealie-households-event-notifications-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/mealie/refs/heads/main/scopes/mealie-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/mealie/refs/heads/main/errors/mealie-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/mealie/refs/heads/main/data-model/mealie-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/mealie/refs/heads/main/conventions/mealie-conventions.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/mealie/refs/heads/main/asyncapi/mealie-events.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/mealie/refs/heads/main/conformance/mealie-conformance.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/mealie/refs/heads/main/lifecycle/mealie-lifecycle.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/mealie/refs/heads/main/sandbox/mealie-sandbox.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mealie-households-event-notifications-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

mealie-households-event-notifications-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: 'Mealie Households: Event Notifications API'
  description: Mealie is a web application for managing your recipes, meal plans, and shopping lists.
  version: nightly
tags:
- name: 'Households: Event Notifications'
paths:
  /api/households/events/notifications:
    get:
      tags:
      - 'Households: Event Notifications'
      summary: Get All
      operationId: get_all_api_households_events_notifications_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: orderBy
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Orderby
      - name: orderByNullPosition
        in: query
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/OrderByNullPosition'
          - type: 'null'
          title: Orderbynullposition
      - name: orderDirection
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/OrderDirection'
          default: desc
      - name: queryFilter
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Queryfilter
      - name: paginationSeed
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Paginationseed
      - name: page
        in: query
        required: false
        schema:
          type: integer
          default: 1
          title: Page
      - name: perPage
        in: query
        required: false
        schema:
          type: integer
          default: 50
          title: Perpage
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupEventPagination'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - 'Households: Event Notifications'
      summary: Create One
      operationId: create_one_api_households_events_notifications_post
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupEventNotifierCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupEventNotifierOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/households/events/notifications/{item_id}:
    get:
      tags:
      - 'Households: Event Notifications'
      summary: Get One
      operationId: get_one_api_households_events_notifications__item_id__get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: item_id
        in: path
        required: true
        schema:
          type: string
          format: uuid4
          title: Item Id
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupEventNotifierOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - 'Households: Event Notifications'
      summary: Update One
      operationId: update_one_api_households_events_notifications__item_id__put
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: item_id
        in: path
        required: true
        schema:
          type: string
          format: uuid4
          title: Item Id
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GroupEventNotifierUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupEventNotifierOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - 'Households: Event Notifications'
      summary: Delete One
      operationId: delete_one_api_households_events_notifications__item_id__delete
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: item_id
        in: path
        required: true
        schema:
          type: string
          format: uuid4
          title: Item Id
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/households/events/notifications/{item_id}/test:
    post:
      tags:
      - 'Households: Event Notifications'
      summary: Test Notification
      operationId: test_notification_api_households_events_notifications__item_id__test_post
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: item_id
        in: path
        required: true
        schema:
          type: string
          format: uuid4
          title: Item Id
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GroupEventNotifierOptions:
      properties:
        testMessage:
          type: boolean
          title: Testmessage
          default: false
        webhookTask:
          type: boolean
          title: Webhooktask
          default: false
        recipeCreated:
          type: boolean
          title: Recipecreated
          default: false
        recipeUpdated:
          type: boolean
          title: Recipeupdated
          default: false
        recipeDeleted:
          type: boolean
          title: Recipedeleted
          default: false
        userSignup:
          type: boolean
          title: Usersignup
          default: false
        dataMigrations:
          type: boolean
          title: Datamigrations
          default: false
        dataExport:
          type: boolean
          title: Dataexport
          default: false
        dataImport:
          type: boolean
          title: Dataimport
          default: false
        mealplanEntryCreated:
          type: boolean
          title: Mealplanentrycreated
          default: false
        mealplanEntryUpdated:
          type: boolean
          title: Mealplanentryupdated
          default: false
        mealplanEntryDeleted:
          type: boolean
          title: Mealplanentrydeleted
          default: false
        shoppingListCreated:
          type: boolean
          title: Shoppinglistcreated
          default: false
        shoppingListUpdated:
          type: boolean
          title: Shoppinglistupdated
          default: false
        shoppingListDeleted:
          type: boolean
          title: Shoppinglistdeleted
          default: false
        cookbookCreated:
          type: boolean
          title: Cookbookcreated
          default: false
        cookbookUpdated:
          type: boolean
          title: Cookbookupdated
          default: false
        cookbookDeleted:
          type: boolean
          title: Cookbookdeleted
          default: false
        tagCreated:
          type: boolean
          title: Tagcreated
          default: false
        tagUpdated:
          type: boolean
          title: Tagupdated
          default: false
        tagDeleted:
          type: boolean
          title: Tagdeleted
          default: false
        categoryCreated:
          type: boolean
          title: Categorycreated
          default: false
        categoryUpdated:
          type: boolean
          title: Categoryupdated
          default: false
        categoryDeleted:
          type: boolean
          title: Categorydeleted
          default: false
        labelCreated:
          type: boolean
          title: Labelcreated
          default: false
        labelUpdated:
          type: boolean
          title: Labelupdated
          default: false
        labelDeleted:
          type: boolean
          title: Labeldeleted
          default: false
      type: object
      title: GroupEventNotifierOptions
      description: 'These events are in-sync with the EventTypes found in the EventBusService.

        If you modify this, make sure to update the EventBusService as well.'
    OrderDirection:
      type: string
      enum:
      - asc
      - desc
      title: OrderDirection
    GroupEventNotifierOut:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
        name:
          type: string
          title: Name
        enabled:
          type: boolean
          title: Enabled
        groupId:
          type: string
          format: uuid4
          title: Groupid
        householdId:
          type: string
          format: uuid4
          title: Householdid
        options:
          $ref: '#/components/schemas/GroupEventNotifierOptionsOut'
      type: object
      required:
      - id
      - name
      - enabled
      - groupId
      - householdId
      - options
      title: GroupEventNotifierOut
    GroupEventNotifierUpdate:
      properties:
        name:
          type: string
          title: Name
        appriseUrl:
          anyOf:
          - type: string
          - type: 'null'
          title: Appriseurl
        enabled:
          type: boolean
          title: Enabled
          default: true
        groupId:
          type: string
          format: uuid4
          title: Groupid
        householdId:
          type: string
          format: uuid4
          title: Householdid
        options:
          $ref: '#/components/schemas/GroupEventNotifierOptions'
          default:
            testMessage: false
            webhookTask: false
            recipeCreated: false
            recipeUpdated: false
            recipeDeleted: false
            userSignup: false
            dataMigrations: false
            dataExport: false
            dataImport: false
            mealplanEntryCreated: false
            mealplanEntryUpdated: false
            mealplanEntryDeleted: 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
            labelCreated: false
            labelUpdated: false
            labelDeleted: false
        id:
          type: string
          format: uuid4
          title: Id
      type: object
      required:
      - name
      - groupId
      - householdId
      - id
      title: GroupEventNotifierUpdate
    GroupEventNotifierOptionsOut:
      properties:
        testMessage:
          type: boolean
          title: Testmessage
          default: false
        webhookTask:
          type: boolean
          title: Webhooktask
          default: false
        recipeCreated:
          type: boolean
          title: Recipecreated
          default: false
        recipeUpdated:
          type: boolean
          title: Recipeupdated
          default: false
        recipeDeleted:
          type: boolean
          title: Recipedeleted
          default: false
        userSignup:
          type: boolean
          title: Usersignup
          default: false
        dataMigrations:
          type: boolean
          title: Datamigrations
          default: false
        dataExport:
          type: boolean
          title: Dataexport
          default: false
        dataImport:
          type: boolean
          title: Dataimport
          default: false
        mealplanEntryCreated:
          type: boolean
          title: Mealplanentrycreated
          default: false
        mealplanEntryUpdated:
          type: boolean
          title: Mealplanentryupdated
          default: false
        mealplanEntryDeleted:
          type: boolean
          title: Mealplanentrydeleted
          default: false
        shoppingListCreated:
          type: boolean
          title: Shoppinglistcreated
          default: false
        shoppingListUpdated:
          type: boolean
          title: Shoppinglistupdated
          default: false
        shoppingListDeleted:
          type: boolean
          title: Shoppinglistdeleted
          default: false
        cookbookCreated:
          type: boolean
          title: Cookbookcreated
          default: false
        cookbookUpdated:
          type: boolean
          title: Cookbookupdated
          default: false
        cookbookDeleted:
          type: boolean
          title: Cookbookdeleted
          default: false
        tagCreated:
          type: boolean
          title: Tagcreated
          default: false
        tagUpdated:
          type: boolean
          title: Tagupdated
          default: false
        tagDeleted:
          type: boolean
          title: Tagdeleted
          default: false
        categoryCreated:
          type: boolean
          title: Categorycreated
          default: false
        categoryUpdated:
          type: boolean
          title: Categoryupdated
          default: false
        categoryDeleted:
          type: boolean
          title: Categorydeleted
          default: false
        labelCreated:
          type: boolean
          title: Labelcreated
          default: false
        labelUpdated:
          type: boolean
          title: Labelupdated
          default: false
        labelDeleted:
          type: boolean
          title: Labeldeleted
          default: false
        id:
          type: string
          format: uuid4
          title: Id
      type: object
      required:
      - id
      title: GroupEventNotifierOptionsOut
    OrderByNullPosition:
      type: string
      enum:
      - first
      - last
      title: OrderByNullPosition
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    GroupEventPagination:
      properties:
        page:
          type: integer
          title: Page
          default: 1
        per_page:
          type: integer
          title: Per Page
          default: 10
        total:
          type: integer
          title: Total
          default: 0
        total_pages:
          type: integer
          title: Total Pages
          default: 0
        items:
          items:
            $ref: '#/components/schemas/GroupEventNotifierOut'
          type: array
          title: Items
        next:
          anyOf:
          - type: string
          - type: 'null'
          title: Next
        previous:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous
      type: object
      required:
      - items
      title: GroupEventPagination
    GroupEventNotifierCreate:
      properties:
        name:
          type: string
          title: Name
        appriseUrl:
          anyOf:
          - type: string
          - type: 'null'
          title: Appriseurl
      type: object
      required:
      - name
      title: GroupEventNotifierCreate
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/auth/token