openapi: 3.2.0
info:
  title: 'Mealie Admin: Manage Households API'
  description: '

    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](https://docs.mealie.io/documentation/getting-started/api-usage/)

    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](https://github.com/mealie-recipes/mealie/issues/new/choose)



    ## Helpful Links

    - [Home Page](https://mealie.io)

    - [Documentation](https://docs.mealie.io)

    - [Discord](https://discord.gg/QuStdQGSGK)

    - [Demo](https://demo.mealie.io)

    '
  version: nightly
tags:
- name: 'Admin: Manage Households'
paths:
  /api/admin/households:
    get:
      tags:
      - 'Admin: Manage Households'
      summary: Get All
      operationId: get_all_api_admin_households_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/HouseholdPagination'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - 'Admin: Manage Households'
      summary: Create One
      operationId: create_one_api_admin_households_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/HouseholdCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HouseholdInDB'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/households/{item_id}:
    get:
      tags:
      - 'Admin: Manage Households'
      summary: Get One
      operationId: get_one_api_admin_households__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/HouseholdInDB'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - 'Admin: Manage Households'
      summary: Update One
      operationId: update_one_api_admin_households__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/UpdateHouseholdAdmin'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HouseholdInDB'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - 'Admin: Manage Households'
      summary: Delete One
      operationId: delete_one_api_admin_households__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:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HouseholdInDB'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    UpdateHouseholdPreferences:
      properties:
        privateHousehold:
          type: boolean
          title: Privatehousehold
          default: true
        showAnnouncements:
          type: boolean
          title: Showannouncements
          default: true
        lockRecipeEditsFromOtherHouseholds:
          type: boolean
          title: Lockrecipeeditsfromotherhouseholds
          default: true
        firstDayOfWeek:
          type: integer
          title: Firstdayofweek
          default: 0
        recipePublic:
          type: boolean
          title: Recipepublic
          default: true
        recipeShowNutrition:
          type: boolean
          title: Recipeshownutrition
          default: false
        recipeShowAssets:
          type: boolean
          title: Recipeshowassets
          default: false
        recipeLandscapeView:
          type: boolean
          title: Recipelandscapeview
          default: false
        recipeDisableComments:
          type: boolean
          title: Recipedisablecomments
          default: false
      type: object
      title: UpdateHouseholdPreferences
    HouseholdPagination:
      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/HouseholdInDB'
          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: HouseholdPagination
    ReadWebhook:
      properties:
        enabled:
          type: boolean
          title: Enabled
          default: true
        name:
          type: string
          title: Name
          default: ''
        url:
          type: string
          title: Url
          default: ''
        webhookType:
          $ref: '#/components/schemas/WebhookType'
          default: mealplan
        scheduledTime:
          type: string
          format: time
          title: Scheduledtime
        groupId:
          type: string
          format: uuid4
          title: Groupid
        householdId:
          type: string
          format: uuid4
          title: Householdid
        id:
          type: string
          format: uuid4
          title: Id
      type: object
      required:
      - scheduledTime
      - groupId
      - householdId
      - id
      title: ReadWebhook
    HouseholdCreate:
      properties:
        groupId:
          anyOf:
          - type: string
            format: uuid4
          - type: 'null'
          title: Groupid
        name:
          type: string
          minLength: 1
          title: Name
      type: object
      required:
      - name
      title: HouseholdCreate
    UpdateHouseholdAdmin:
      properties:
        groupId:
          type: string
          format: uuid4
          title: Groupid
        name:
          type: string
          minLength: 1
          title: Name
        id:
          type: string
          format: uuid4
          title: Id
        preferences:
          anyOf:
          - $ref: '#/components/schemas/UpdateHouseholdPreferences'
          - type: 'null'
      type: object
      required:
      - groupId
      - name
      - id
      title: UpdateHouseholdAdmin
    HouseholdUserSummary:
      properties:
        id:
          type: string
          format: uuid4
          title: Id
        fullName:
          type: string
          title: Fullname
      type: object
      required:
      - id
      - fullName
      title: HouseholdUserSummary
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OrderDirection:
      type: string
      enum:
      - asc
      - desc
      title: OrderDirection
    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
    ReadHouseholdPreferences:
      properties:
        privateHousehold:
          type: boolean
          title: Privatehousehold
          default: true
        showAnnouncements:
          type: boolean
          title: Showannouncements
          default: true
        lockRecipeEditsFromOtherHouseholds:
          type: boolean
          title: Lockrecipeeditsfromotherhouseholds
          default: true
        firstDayOfWeek:
          type: integer
          title: Firstdayofweek
          default: 0
        recipePublic:
          type: boolean
          title: Recipepublic
          default: true
        recipeShowNutrition:
          type: boolean
          title: Recipeshownutrition
          default: false
        recipeShowAssets:
          type: boolean
          title: Recipeshowassets
          default: false
        recipeLandscapeView:
          type: boolean
          title: Recipelandscapeview
          default: false
        recipeDisableComments:
          type: boolean
          title: Recipedisablecomments
          default: false
        id:
          type: string
          format: uuid4
          title: Id
      type: object
      required:
      - id
      title: ReadHouseholdPreferences
    HouseholdInDB:
      properties:
        groupId:
          type: string
          format: uuid4
          title: Groupid
        name:
          type: string
          minLength: 1
          title: Name
        id:
          type: string
          format: uuid4
          title: Id
        slug:
          type: string
          title: Slug
        preferences:
          anyOf:
          - $ref: '#/components/schemas/ReadHouseholdPreferences'
          - type: 'null'
        group:
          type: string
          title: Group
        users:
          anyOf:
          - items:
              $ref: '#/components/schemas/HouseholdUserSummary'
            type: array
          - type: 'null'
          title: Users
        webhooks:
          items:
            $ref: '#/components/schemas/ReadWebhook'
          type: array
          title: Webhooks
          default: []
      type: object
      required:
      - groupId
      - name
      - id
      - slug
      - group
      title: HouseholdInDB
    OrderByNullPosition:
      type: string
      enum:
      - first
      - last
      title: OrderByNullPosition
    WebhookType:
      type: string
      enum:
      - mealplan
      title: WebhookType
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/auth/token