Mealie

Mealie Groups: Self Service API

The Groups: Self Service API from Mealie — 5 operation(s) for groups: self service.

GitHub OpenAPI

Operations 6

GET /api/groups/self Get Logged In User Group #
GET /api/groups/members Get Group Members #
GET /api/groups/members/{username_or_id} Get Group Member #
GET /api/groups/preferences Get Group Preferences #
PUT /api/groups/preferences Update Group Preferences #
GET /api/groups/storage Get Storage #

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-groups-self-service-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-groups-self-service-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-groups-self-service-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: 'Mealie Groups: Self Service API'
  description: Mealie is a web application for managing your recipes, meal plans, and shopping lists.
  version: nightly
tags:
- name: 'Groups: Self Service'
paths:
  /api/groups/self:
    get:
      tags:
      - 'Groups: Self Service'
      summary: Get Logged In User Group
      description: Returns the Group Data for the Current User
      operationId: get_logged_in_user_group_api_groups_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/GroupSummary'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/groups/members:
    get:
      tags:
      - 'Groups: Self Service'
      summary: Get Group Members
      description: Returns all users belonging to the current group
      operationId: get_group_members_api_groups_members_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/PaginationBase_UserSummary_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/groups/members/{username_or_id}:
    get:
      tags:
      - 'Groups: Self Service'
      summary: Get Group Member
      description: Returns a single user belonging to the current group
      operationId: get_group_member_api_groups_members__username_or_id__get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: username_or_id
        in: path
        required: true
        schema:
          anyOf:
          - type: string
          - type: string
            format: uuid4
          title: Username Or 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/UserSummary'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/groups/preferences:
    get:
      tags:
      - 'Groups: Self Service'
      summary: Get Group Preferences
      operationId: get_group_preferences_api_groups_preferences_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/ReadGroupPreferences'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - 'Groups: Self Service'
      summary: Update Group Preferences
      operationId: update_group_preferences_api_groups_preferences_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/UpdateGroupPreferences'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadGroupPreferences'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/groups/storage:
    get:
      tags:
      - 'Groups: Self Service'
      summary: Get Storage
      operationId: get_storage_api_groups_storage_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/GroupStorage'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ReadGroupPreferences:
      properties:
        privateGroup:
          type: boolean
          title: Privategroup
          default: true
        showAnnouncements:
          type: boolean
          title: Showannouncements
          default: true
        groupId:
          type: string
          format: uuid
          title: Groupid
        id:
          type: string
          format: uuid4
          title: Id
      type: object
      required:
      - groupId
      - id
      title: ReadGroupPreferences
    AIProviderSummary:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
        name:
          type: string
          title: Name
      type: object
      required:
      - id
      - name
      title: AIProviderSummary
    UpdateGroupPreferences:
      properties:
        privateGroup:
          type: boolean
          title: Privategroup
          default: true
        showAnnouncements:
          type: boolean
          title: Showannouncements
          default: true
      type: object
      title: UpdateGroupPreferences
    UserSummary:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
        groupId:
          type: string
          format: uuid4
          title: Groupid
        householdId:
          type: string
          format: uuid4
          title: Householdid
        username:
          type: string
          title: Username
        fullName:
          type: string
          title: Fullname
      type: object
      required:
      - id
      - groupId
      - householdId
      - username
      - fullName
      title: UserSummary
    OrderDirection:
      type: string
      enum:
      - asc
      - desc
      title: OrderDirection
    GroupStorage:
      properties:
        usedStorageBytes:
          type: integer
          title: Usedstoragebytes
        usedStorageStr:
          type: string
          title: Usedstoragestr
        totalStorageBytes:
          type: integer
          title: Totalstoragebytes
        totalStorageStr:
          type: string
          title: Totalstoragestr
      type: object
      required:
      - usedStorageBytes
      - usedStorageStr
      - totalStorageBytes
      - totalStorageStr
      title: GroupStorage
    OrderByNullPosition:
      type: string
      enum:
      - first
      - last
      title: OrderByNullPosition
    PaginationBase_UserSummary_:
      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/UserSummary'
          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: PaginationBase[UserSummary]
    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
    GroupSummary:
      properties:
        name:
          type: string
          title: Name
        id:
          type: string
          format: uuid4
          title: Id
        slug:
          type: string
          title: Slug
        preferences:
          anyOf:
          - $ref: '#/components/schemas/ReadGroupPreferences'
          - type: 'null'
        aiProviderSettings:
          anyOf:
          - $ref: '#/components/schemas/AIProviderSettingsOut'
          - type: 'null'
      type: object
      required:
      - name
      - id
      - slug
      title: GroupSummary
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    AIProviderSettingsOut:
      properties:
        defaultProviderId:
          anyOf:
          - type: string
            format: uuid4
          - type: 'null'
          title: Defaultproviderid
        audioProviderId:
          anyOf:
          - type: string
            format: uuid4
          - type: 'null'
          title: Audioproviderid
        imageProviderId:
          anyOf:
          - type: string
            format: uuid4
          - type: 'null'
          title: Imageproviderid
        providers:
          items:
            $ref: '#/components/schemas/AIProviderSummary'
          type: array
          title: Providers
        aiEnabled:
          type: boolean
          title: Aienabled
          readOnly: true
        audioProviderEnabled:
          type: boolean
          title: Audioproviderenabled
          readOnly: true
        imageProviderEnabled:
          type: boolean
          title: Imageproviderenabled
          readOnly: true
      type: object
      required:
      - defaultProviderId
      - audioProviderId
      - imageProviderId
      - providers
      - aiEnabled
      - audioProviderEnabled
      - imageProviderEnabled
      title: AIProviderSettingsOut
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/auth/token