Mealie

Mealie Users: CRUD API

The Users: CRUD API from Mealie — 6 operation(s) for users: crud.

GitHub OpenAPI

Operations 6

GET /api/users/self Get Logged In User #
GET /api/users/self/ratings Get Logged In User Ratings #
GET /api/users/self/ratings/{recipe_id} Get Logged In User Rating For Recipe #
GET /api/users/self/favorites Get Logged In User Favorites #
PUT /api/users/password Update Password #
PUT /api/users/{item_id} Update User #

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-users-crud-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-users-crud-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-users-crud-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: 'Mealie Users: CRUD API'
  description: Mealie is a web application for managing your recipes, meal plans, and shopping lists.
  version: nightly
tags:
- name: 'Users: CRUD'
paths:
  /api/users/self:
    get:
      tags:
      - 'Users: CRUD'
      summary: Get Logged In User
      operationId: get_logged_in_user_api_users_self_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - 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/UserOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/users/self/ratings:
    get:
      tags:
      - 'Users: CRUD'
      summary: Get Logged In User Ratings
      operationId: get_logged_in_user_ratings_api_users_self_ratings_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - 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/UserRatings_UserRatingSummary_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/users/self/ratings/{recipe_id}:
    get:
      tags:
      - 'Users: CRUD'
      summary: Get Logged In User Rating For Recipe
      operationId: get_logged_in_user_rating_for_recipe_api_users_self_ratings__recipe_id__get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: recipe_id
        in: path
        required: true
        schema:
          type: string
          format: uuid4
          title: Recipe 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/UserRatingSummary'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/users/self/favorites:
    get:
      tags:
      - 'Users: CRUD'
      summary: Get Logged In User Favorites
      operationId: get_logged_in_user_favorites_api_users_self_favorites_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - 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/UserRatings_UserRatingSummary_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/users/password:
    put:
      tags:
      - 'Users: CRUD'
      summary: Update Password
      description: Resets the User Password
      operationId: update_password_api_users_password_put
      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/ChangePassword'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/users/{item_id}:
    put:
      tags:
      - 'Users: CRUD'
      summary: Update User
      operationId: update_user_api_users__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/mealie__schema__user__user__UserBase'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    LongLiveTokenOut:
      properties:
        name:
          type: string
          title: Name
        id:
          type: integer
          title: Id
        createdAt:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Createdat
      type: object
      required:
      - name
      - id
      title: LongLiveTokenOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserRatings_UserRatingSummary_:
      properties:
        ratings:
          items:
            $ref: '#/components/schemas/UserRatingSummary'
          type: array
          title: Ratings
      type: object
      required:
      - ratings
      title: UserRatings[UserRatingSummary]
    mealie__schema__user__user__UserBase:
      properties:
        id:
          anyOf:
          - type: string
            format: uuid4
          - type: 'null'
          title: Id
        username:
          anyOf:
          - type: string
          - type: 'null'
          title: Username
        fullName:
          anyOf:
          - type: string
          - type: 'null'
          title: Fullname
        email:
          type: string
          title: Email
        authMethod:
          $ref: '#/components/schemas/AuthMethod'
          default: Mealie
        admin:
          type: boolean
          title: Admin
          default: false
        group:
          anyOf:
          - type: string
          - type: 'null'
          title: Group
        household:
          anyOf:
          - type: string
          - type: 'null'
          title: Household
        advanced:
          type: boolean
          title: Advanced
          default: false
        showAnnouncements:
          type: boolean
          title: Showannouncements
          default: true
        lastReadAnnouncement:
          anyOf:
          - type: string
          - type: 'null'
          title: Lastreadannouncement
        canInvite:
          type: boolean
          title: Caninvite
          default: false
        canManage:
          type: boolean
          title: Canmanage
          default: false
        canManageHousehold:
          type: boolean
          title: Canmanagehousehold
          default: false
        canOrganize:
          type: boolean
          title: Canorganize
          default: false
      type: object
      required:
      - email
      title: UserBase
      example:
        admin: 'false'
        email: changeme@example.com
        fullName: Change Me
        group: home
        household: Family
        username: ChangeMe
    AuthMethod:
      type: string
      enum:
      - Mealie
      - LDAP
      - OIDC
      title: AuthMethod
    ChangePassword:
      properties:
        currentPassword:
          type: string
          title: Currentpassword
          default: ''
        newPassword:
          type: string
          minLength: 8
          title: Newpassword
      type: object
      required:
      - newPassword
      title: ChangePassword
    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
    UserRatingSummary:
      properties:
        recipeId:
          type: string
          format: uuid4
          title: Recipeid
        rating:
          anyOf:
          - type: number
          - type: 'null'
          title: Rating
        isFavorite:
          type: boolean
          title: Isfavorite
          default: false
      type: object
      required:
      - recipeId
      title: UserRatingSummary
    UserOut:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
        username:
          anyOf:
          - type: string
          - type: 'null'
          title: Username
        fullName:
          anyOf:
          - type: string
          - type: 'null'
          title: Fullname
        email:
          type: string
          title: Email
        authMethod:
          $ref: '#/components/schemas/AuthMethod'
          default: Mealie
        admin:
          type: boolean
          title: Admin
          default: false
        group:
          type: string
          title: Group
        household:
          type: string
          title: Household
        advanced:
          type: boolean
          title: Advanced
          default: false
        showAnnouncements:
          type: boolean
          title: Showannouncements
          default: true
        lastReadAnnouncement:
          anyOf:
          - type: string
          - type: 'null'
          title: Lastreadannouncement
        canInvite:
          type: boolean
          title: Caninvite
          default: false
        canManage:
          type: boolean
          title: Canmanage
          default: false
        canManageHousehold:
          type: boolean
          title: Canmanagehousehold
          default: false
        canOrganize:
          type: boolean
          title: Canorganize
          default: false
        groupId:
          type: string
          format: uuid4
          title: Groupid
        groupSlug:
          type: string
          title: Groupslug
        householdId:
          type: string
          format: uuid4
          title: Householdid
        householdSlug:
          type: string
          title: Householdslug
        tokens:
          anyOf:
          - items:
              $ref: '#/components/schemas/LongLiveTokenOut'
            type: array
          - type: 'null'
          title: Tokens
        cacheKey:
          type: string
          title: Cachekey
      type: object
      required:
      - id
      - email
      - group
      - household
      - groupId
      - groupSlug
      - householdId
      - householdSlug
      - cacheKey
      title: UserOut
      example:
        admin: 'false'
        email: changeme@example.com
        fullName: Change Me
        group: home
        household: Family
        username: ChangeMe
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/auth/token