openapi.yaml

---
openapi: 3.1.1
info:
  title: Habitica API
  description: Habitica API representation as OpenAPI spec
  version: 1.0.0
  contact:
    name: Specification repository
    url: https://github.com/igromanru/habitica-api
externalDocs:
  url: https://habitica.com/apidoc/
  description: Official Habitica API Documentation
servers:
  - url: https://habitica.com/api
    description: Habitica API server
tags:
  - name: default
  - name: hall
    description: Hall of Fame related requests
  - name: members
    description: Habitica members related requests
  - name: user
    description: User related requests
  - name: tasks
    description: Tasks related requests
  - name: tags
    description: Tags related requests
  - name: party
    description: Party related requests
  - name: groups
    description: |
      Groups related requests \
      Most endpoints accept 'party' and 'habitrpg' as the {groupId} \
      Use `party` for user's current party and `habitrpg` for the tavern
  - name: chat
    description: Chat related requests
  - name: challenges
    description: Challenges related requests
  - name: webhook
    description: Webhooks
  - name: news
    description: Habitica News related requests
  - name: notifications
    description: Notifications related requests
  - name: coupons
    description: Coupons related requests
  - name: data-export
    description: Data Export related requests
  - name: development
    description: |
      Development related requests \
      **These routes only exist while Habitica is in development mode. (Such as running a local instance on your computer)**
components:
  securitySchemes:
    userId:
      type: apiKey
      in: header
      name: x-api-user
    apiToken:
      type: apiKey
      in: header
      name: x-api-key
    xClient:
      type: apiKey
      in: header
      name: x-client
  schemas:
    DataResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates the success status of the response.
        data:
          type: object
          description: The data object.
          additionalProperties: true
        notifications:
          type: array
          items:
            type: object
            additionalProperties: true
          description: An array of notifications.
        userV:
          type: number
          example: 4212
        appVersion:
          type: string
          description: The app version.
          example: "4.276.0"
    DataWithMessageResponse:
      allOf:
        - $ref: "#/components/schemas/DataResponse"
        - type: object
          properties:
            message:
              type: string
              description: Success message.
    ErrorMessageResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Indicates the success status of the response.
          example: false
        error:
          type: string
          description: The error code or identifier.
          example: "NotAuthorized"
        message:
          type: string
          description: The error message.
          example: "Missing authentication headers."
    BugReportRequest:
      type: object
      properties:
        message:
          type: string
          description: User's Email.
        email:
          type: string
          description: Bug Report Message to sent.
    EditUserRequest:
      type: object
      properties:
        achievements:
          type: object
          additionalProperties: true
        stats:
          type: object
          additionalProperties: true
        profile:
          type: object
          additionalProperties: true
        flags:
          type: object
          additionalProperties: true
        preferences:
          type: object
          additionalProperties: true
    DeleteUserRequest:
      type: object
      properties:
        password:
          type: string
        feedback:
          type: string
          example: "I'm leaving because..."
    UpdateUsernameRequest:
      type: object
      properties:
        username:
          type: string
          description: The new username
        password:
          type: string
          description: The user's password if they use local authentication. Omit if they use social auth.
      required:
        - username
    UpdateEmailRequest:
      type: object
      properties:
        newEmail:
          type: string
          description: The new email address
        password:
          type: string
          description: The user password
      required:
        - newEmail
    UpdatePasswordRequest:
      type: object
      properties:
        password:
          type: string
          description: The old password
        newPassword:
          type: string
          description: The new password
        confirmPassword:
          type: string
          description: New password confirmation
      required:
        - username
    PrivateMessageRequest:
      type: object
      required:
        - message
        - toUserId
      properties:
        message:
          type: string
          description: The private message to be sent.
        toUserId:
          type: string
          format: uuid
          description: The UUID of the user to whom the message will be sent.
    NewsResponse:
      type: object
      properties:
        html:
          type: string
          description: Latest Bailey announcement as HTML.
    ChallengeRequest:
      type: object
      properties:
        group:
          type: string
          format: uuid
          description: The UUID of the group to which the challenge belongs.
        name:
          type: string
          description: The full name of the challenge.
          example: Fitness Challenge
        shortName:
          type: string
          description: A shortened name for the challenge, to be used as a tag.
        summary:
          type: string
          description: A short summary advertising the main purpose of the challenge; maximum 250 characters; if not supplied, challenge.name will be used.
        description:
          type: string
          description: A detailed description of the challenge.
        official:
          type: boolean
          description: Specifies whether the challenge is an official Habitica challenge.
          default: false
        prize:
          type: number
          description: The prize or reward associated with the challenge.
          default: 0
      required:
        - group
        - name
        - shortName
    ChallengeUpdateRequest:
      type: object
      properties:
        name:
          type: string
          description: The new full name of the challenge.
        summary:
          type: string
          description: The new challenge summary.
        description:
          type: string
          description: The new challenge description.
    LeaveChallengeRequest:
      type: object
      properties:
        keep:
          type: string
          enum: [remove-all, keep-all]
          default: keep-all
          description: Specify whether to remove all or keep all challenge-related tasks upon leaving.
    NewsPost:
      type: object
      properties:
        title:
          type: string
          description: The title of the news article.
        text:
          type: string
          description: The content or body of the news article.
        credits:
          type: string
          description: The credits or source of the news article.
        author:
          type: string
          description: The author of the news article.
        publishDate:
          type: string
          format: date-time
          description: The timestamp of the news article publication.
        published:
          type: boolean
          description: Specifies whether the news article is published.
      required:
        - title
        - text
        - credits
        - author
        - publishDate
        - published
    StatAllocation:
      type: object
      properties:
        stats:
          type: object
          properties:
            int:
              type: number
              description: The number of points to allocate to INT (Intelligence) stat.
            str:
              type: number
              description: The number of points to allocate to STR (Strength) stat.
            con:
              type: number
              description: The number of points to allocate to CON (Constitution) stat.
            per:
              type: number
              description: The number of points to allocate to PER (Perception) stat.
          required:
            - int
            - str
            - con
            - per
    ChatMessageRequest:
      type: object
      properties:
        message:
          type: string
          description: The content of the chat message.
    ChatFlagRequest:
      type: object
      properties:
        name:
          type: string
          description: Explanation why the message was flagged.
          example: The message is not appropriate.
    UserTaskRequest:
      type: object
      properties:
        text:
          type: string
          description: The text to be displayed for the task.
        type:
          type: string
          description: "Task type, options are: `habit`, `daily`, `todo`, `reward`."
          enum:
            - habit
            - daily
            - todo
            - reward
          default: habit
        tags:
          type: array
          items:
            type: string
          description: Array of UUIDs of tags.
        alias:
          type: string
          description: Alias to assign to task.
        attribute:
          type: string
          description: "User's attribute to use, options are: `str`, `int`, `per`, `con`"
          enum:
            - str
            - int
            - per
            - con
          default: str
        checklist:
          type: array
          items:
            type: object
            properties:
              text:
                type: string
                description: The text description of the checklist item.
              completed:
                type: boolean
                description: Indicates whether the checklist item is completed or not.
          description: An array of checklist items.
        collapseChecklist:
          type: boolean
          description: Determines if a checklist will be displayed.
          default: false
        notes:
          type: string
          description: Additional notes or details about the task.
        date:
          type: string
          format: date-time
          description: Due date to be shown in task list. Only valid for type "todo."
        priority:
          type: number
          description: Difficulty, options are 0.1, 1, 1.5, 2; equivalent of Trivial, Easy, Medium, Hard.
          default: 1
          enum:
            - 0.1
            - 1
            - 1.5
            - 2
        reminders:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              startDate:
                type: string
                format: date
                example: "1/16/17"
              time:
                type: string
                format: date
                example: "1/16/17"
          description: "Array of reminders, each an object that must include: a UUID, startDate and time."
        frequency:
          type: string
          description: Values "weekly" and "monthly" enable use of the "repeat" field. All frequency values enable use of the "everyX" field. Value "monthly" enables use of the "weeksOfMonth" and "daysOfMonth" fields. Frequency is only valid for type "daily".
          default: weekly
          enum:
            - daily
            - weekly
            - monthly
            - yearly
        repeat:
          type: boolean
          description: 'List of objects for days of the week, Days that are true will be repeated upon. Only valid for type "daily". Any days not specified will be marked as true. Days are: su, m, t, w, th, f, s. Value of frequency must be "weekly".'
          example: true
        everyX:
          type: number
          description: Value of frequency must be "daily", the number of days until this daily task is available again.
          example: 1
        streak:
          type: number
          description: Number of days that the task has consecutively been checked off. Only valid for type "daily".
          example: 0
        daysOfMonth:
          type: array
          items:
            type: number
          description: Array of integers. Only valid for type "daily".
        weeksOfMonth:
          type: array
          items:
            type: string
          description: Array of integers. Only valid for type "daily".
        startDate:
          type: string
          format: date
          description: Date when the task will first become available. Only valid for type "daily".
        up:
          type: boolean
          description: Only valid for type "habit" If true, enables the "+" under "Directions/Action" for "Good habits".
          example: true
        down:
          type: boolean
          description: Only valid for type "habit" If true, enables the "-" under "Directions/Action" for "Bad habits".
          example: true
        value:
          type: number
          description: Only valid for type "reward." The cost in gold of the reward. Should be greater then or equal to 0.
          example: 0
      required:
        - text
        - type
    PurchaseItemRequest:
      type: object
      properties:
        quantity:
          type: integer
          minimum: 1
          default: 1
          description: Count of items to buy. Defaults to 1 and is ignored for items where quantity is irrelevant.
    LeaveGroupRequest:
      type: object
      properties:
        keepChallenges:
          type: string
          enum:
            - remain-in-challenges
            - leave-challenges
          default: leave-challenges
          description: Specify whether to remain in challenges or leave challenges upon leaving the group.
    GroupPlanCreateRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the group plan.
        description:
          type: string
          description: The description of the group plan.
        gems:
          type: integer
          description: The number of gems required for the plan.
        interval:
          type: string
          description: The interval of the plan in cron syntax.
    CustomDayStartRequest:
      type: object
      properties:
        dayStart:
          type: number
          description: The hour number (0-23) for the day to begin. If not supplied, it will default to 0.
          minimum: 0
          maximum: 23
          default: 0
    CreateOrUpdateGroupRequest:
      type: object
      required:
        - name
        - type
        - privacy
      properties:
        name:
          type: string
          description: The name of the new group.
        type:
          type: string
          enum: ["guild", "party"]
          example: guild
          description: Type of group (guild or party)
        privacy:
          type: string
          enum: ["private", "public"]
          example: public
          description: Privacy of group (party MUST be private)
    AddOrRemoveManagerRequest:
      type: object
      required:
        - managerId
      properties:
        managerId:
          type: string
          format: uuid
          description: The UUID of the user.
    GroupInviteRequest:
      type: object
      properties:
        emails:
          type: array
          description: An array of objects, each representing one email address to invite.
          items:
            type: object
            properties:
              email:
                type: string
                format: email
                description: The email address of the user being invited.
              name:
                type: string
                description: The name of the user being invited.
            required:
              - email
        uuids:
          type: array
          description: An array of user IDs to invite.
          items:
            type: string
            format: uuid
    TransferGemsRequest:
      type: object
      properties:
        message:
          type: string
          description: The message to the user
        toUserId:
          type: string
          format: uuid
          description: The user to send the gift to
        gemAmount:
          type: integer
          description: The number of gems to send
    WebhookCreateRequest:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The webhook's id.
        url:
          type: string
          description: The webhook's URL.
        label:
          type: string
          description: A label to remind you what this webhook does.
        enabled:
          type: boolean
          description: If the webhook should be enabled.
          default: true
        type:
          type: string
          description: The webhook's type.
          enum:
            [
              "taskActivity",
              "groupChatReceived",
              "userActivity",
              "questActivity",
            ]
          default: taskActivity
        options:
          type: object
          description: The webhook's options. Will differ depending on type. Required for `groupChatReceived` type. If a webhook supports options, the default values are displayed in the examples below.
          additionalProperties: true
      required:
        - url
    WebhookUpdateRequest:
      type: object
      properties:
        url:
          type: string
          description: The webhook's URL.
        label:
          type: string
          description: A label to remind you what this webhook does.
        enabled:
          type: boolean
          description: If the webhook should be enabled.
        type:
          type: string
          enum:
            [
              "taskActivity",
              "groupChatReceived",
              "userActivity",
              "questActivity",
            ]
          description: The webhook's type.
        options:
          type: object
          description: The webhook's options. Will differ depending on type. The options are enumerated in the [add webhook examples](https://habitica.com/apidoc/#api-Webhook-UserAddWebhook).
          additionalProperties: true
    TagCreateOrUpdateRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of the new tag.
          example: morning
    TagReorderRequest:
      type: object
      properties:
        tagId:
          type: string
          format: uuid
          description: The ID of the tag to reorder.
        to:
          type: number
          description: The new position of the tag in the order.
    ChecklistItemRequest:
      type: object
      properties:
        text:
          type: string
          description: The text of the checklist item
        completed:
          type: boolean
          default: false
          description: Whether the checklist item is checked off
      required:
        - text
    TaskAssignRequest:
      type: array
      items:
        type: string
        format: uuid
      description: The ID of the user to whom the task will be assigned
    Task:
      type: object
      properties:
        text:
          type: string
          description: The text to be displayed for the task
        type:
          type: string
          enum: [habit, daily, todo, reward]
          description: "Task type, options are: `habit`, `daily`, `todo`, `reward`"
        attribute:
          type: string
          enum: [str, int, per, con]
          description: "User's attribute to use, options are: `str`, `int`, `per`, `con`"
        collapseChecklist:
          type: boolean
          default: false
          description: Determines if a checklist will be displayed
        notes:
          type: string
          description: Extra notes
        date:
          type: string
          format: date
          description: Due date to be shown in task list. Only valid for type "todo"
        priority:
          type: integer
          enum: [0.1, 1, 1.5, 2]
          default: 1
          description: Difficulty, options are 0.1, 1, 1.5, 2; equivalent of Trivial, Easy, Medium, Hard
        reminders:
          type: array
          items:
            type: string
          description: 'Array of reminders, each an object that must include: a UUID, startDate and time.\nFor example: {"id":"ed427623-9a69-4aac-9852-13deb9c190c3", "startDate":"1/16/17","time":"1/16/17" }'
        frequency:
          type: string
          enum: [daily, weekly, monthly, yearly]
          default: weekly
          description: Values "weekly" and "monthly" enable use of the "repeat" field. All frequency values enable use of the "everyX" field. Value "monthly" enables use of the "weeksOfMonth" and "daysOfMonth" fields. Frequency is only valid for type "daily".
        repeat:
          type: string
          default: "true"
          description: 'List of objects for days of the week, Days that are true will be repeated upon. Only valid for type "daily". Any days not specified will be marked as true. Days are: su, m, t, w, th, f, s. Value of frequency must be "weekly". For example, to skip repeats on Mon and Fri: "repeat":{"f":false,"m":false}'
        everyX:
          type: integer
          default: 1
          description: Value of frequency must be "daily", the number of days until this daily task is available again
        streak:
          type: integer
          default: 0
          description: Number of days that the task has consecutively been checked off. Only valid for type "daily"
        daysOfMonth:
          type: array
          items:
            type: integer
          description: Array of integers. Only valid for type "daily"
        weeksOfMonth:
          type: array
          items:
            type: integer
          description: Array of integers. Only valid for type "daily"
        startDate:
          type: string
          format: date
          description: Date when the task will first become available. Only valid for type "daily"
        up:
          type: boolean
          default: true
          description: Only valid for type "habit" If true, enables the "+" under "Directions/Action" for "Good habits"
        down:
          type: boolean
          default: true
          description: Only valid for type "habit" If true, enables the "-" under "Directions/Action" for "Bad habits"
        value:
          type: integer
          default: 0
          description: Only valid for type "reward." The cost in gold of the reward
      required:
        - text
        - type
    InventoryModificationRequest:
      type: object
      properties:
        gear:
          type: object
          description: Object to replace user's `gear.owned` object.
          additionalProperties: true
        special:
          type: object
          description: Object to replace user's `special` object.
          additionalProperties: true
        pets:
          type: object
          description: Object to replace user's `pets` object.
          additionalProperties: true
        mounts:
          type: object
          description: Object to replace user's `mounts` object.
          additionalProperties: true
        eggs:
          type: object
          description: Object to replace user's `eggs` object.
          additionalProperties: true
        hatchingPotions:
          type: object
          description: Object to replace user's `hatchingPotions` object.
          additionalProperties: true
        food:
          type: object
          description: Object to replace user's `food` object.
          additionalProperties: true
        quests:
          type: object
          description: Object to replace user's `quests` object.
          additionalProperties: true
    HeroUpdateRequest:
      type: object
      additionalProperties: true
    SetLastCronRequest:
      type: object
      properties:
        lastCron:
          type: string
          format: date-time
          description: Last cron date-time
      required:
        - lastCron
paths:
  /v3/status:
    get:
      summary: Get Habitica API status
      description: |
        Endpoint to get the current status of the Habitica API. \
        Returns typical data object with string property "status" that has the value `up`, if the server is running.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "500":
          description: Internal Server Error (The server is down)
  /v3/cron:
    post:
      summary: Run cron
      description:
        This causes cron to run. It assumes that the user has already been
        shown the Record Yesterday's Activity ("Check off any Dailies you did
        yesterday") screen and so it will immediately apply damage for
        incomplete due Dailies.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Cron executed successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v4/bug-report:
    post:
      summary: Submit a bug report
      description: Submit a bug report for the Habitica application.
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/BugReportRequest"
      responses:
        "200":
          description: Bug report submitted successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (The report message is missing)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (The specified user could not be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /email/unsubscribe:
    servers:
      - url: https://habitica.com
    get:
      summary: Unsubscribe an email address or user from email notifications
      description: |
        This is a GET method included in official emails from Habitica that will unsubscribe the user from emails. Does not require authentication. \
        See: [ApiDocs](https://habitica.com/apidoc/#api-Unsubscribe)
      parameters:
        - name: code
          in: query
          schema:
            type: string
          description: An unsubscription code that contains an encrypted User ID or email address
      responses:
        "200":
          description: OK
          content:
            text/html:
              schema:
                type: string
                format: binary
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/i18n/browser-script:
    get:
      summary: Returns the i18n JS script
      description: Returns the i18n JS script to make all the i18n strings available in the browser under window.i18n.strings. Does not require authentication.
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                type: string
                example: (function() {})()
  /v3/world-state:
    get:
      summary: Get World State
      description: Get the state for the game world
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
  /v3/content:
    get:
      summary: Get Content
      description: Get all available content objects.
      parameters:
        - name: language
          in: query
          schema:
            type: string
            enum:
              [
                "bg",
                "cs",
                "da",
                "de",
                "en",
                "en@pirate",
                "en_GB",
                "es",
                "es_419",
                "fr",
                "he",
                "hu",
                "id",
                "it",
                "ja",
                "nl",
                "pl",
                "pt",
                "pt_BR",
                "ro",
                "ru",
                "sk",
                "sr",
                "sv",
                "uk",
                "zh",
                "zh_TW",
              ]
            default: "en"
          description: The desired language for the content data.
      security:
        - xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
  /v3/members/{memberId}:
    parameters:
      - name: memberId
        in: path
        description: ID of the member to retrieve
        required: true
        schema:
          type: string
          format: uuid
    get:
      summary: Get habitica member by ID
      description: Retrieve information about a specific habitica member by member ID.
      tags:
        - members
      responses:
        "200":
          description: Member retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Member not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/members/{memberId}/achievements:
    parameters:
      - name: memberId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The ID of the member whose achievements are to be retrieved.
    get:
      summary: Get member achievements object
      description: et a list of achievements of the requested member, grouped by basic / seasonal / special.
      tags:
        - members
      responses:
        "200":
          description: Successfully retrieved member achievements
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Member not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/members/send-private-message:
    post:
      summary: Send Private Message
      description: Send a private message to another user.
      tags:
        - members
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PrivateMessageRequest"
      responses:
        "200":
          description: Private message sent successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/members/{toUserId}/objections/{interaction}:
    parameters:
      - name: toUserId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The user to interact with
      - name: interaction
        in: path
        required: true
        schema:
          type: string
          enum: [send-private-message, transfer-gems]
          default: send-private-message
        description: Name of the interaction to query.
    get:
      summary: Get objections to interaction
      description: Get any objections that would occur if the given interaction was attempted - BETA.
      tags:
        - members
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Member objections retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/members/transfer-gems:
    post:
      summary: Transfer Gems
      description: Transfer gems from one user to another.
      tags:
        - members
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TransferGemsRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (The specified user could not be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user:
    get:
      summary: Get user information
      description: Retrieve information about the user.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    put:
      summary: Update the user
      description: |
        Some of the user items can be updated, such as preferences, flags and stats. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UserUpdate)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/EditUserRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    delete:
      summary: Delete User Account [Danger]
      description: |
        Delete an authenticated user's account. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UserDelete)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteUserRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (Missing or wrong password. or account deletion feedback is limited to 10,000 characters)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/anonymized:
    get:
      summary: Get anonymized user data
      description: Retrieve anonymized data for the authenticated user.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/class/cast/{spellId}:
    post:
      summary: Cast a skill (spell) on yourself or a target
      description: |
        **Mage:** fireball = "Burst of Flames", mpheal = "Ethereal Surge", earth = "Earthquake", frost = "Chilling Frost" \
        **Warrior:** smash = "Brutal Smash", defensiveStance = "Defensive Stance", valorousPresence = "Valorous Presence", intimidate = "Intimidating Gaze" \
        **Rogue:** pickPocket = "Pickpocket", backStab = "Backstab", toolsOfTrade = "Tools of the Trade", stealth = "Stealth" \
        **Healer:** heal = "Healing Light", protectAura = "Protective Aura", brightness = "Searing Brightness", healAll = "Blessing" \
        **Transformation Items:** snowball = "Snowball", spookySparkles = "Spooky Sparkles", seafoam = "Seafoam", shinySeed = "Shiny Seed"
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: spellId
          in: path
          description: ID of the spell to cast
          required: true
          schema:
            type: string
            enum:
              [
                fireball,
                mpheal,
                earth,
                frost,
                smash,
                defensiveStance,
                valorousPresence,
                intimidate,
                pickPocket,
                backStab,
                toolsOfTrade,
                stealth,
                heal,
                protectAura,
                brightness,
                healAll,
                snowball,
                spookySparkles,
                seafoam,
                shinySeed,
              ]
        - name: targetId
          in: query
          description: User ID of the target (optional)
          required: false
          schema:
            type: string
            format: uuid
      responses:
        "200":
          description: |
            Spell cast successfully. \
            Will return the modified targets. For party members only the necessary fields will be populated. The user is always returned.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/sleep:
    post:
      summary: Make the user start / stop sleeping (resting in the Inn)
      description: Toggles the sleep key under user preference true and false.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: '"data" current user.preferences.sleep state (true/false)'
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/mark-pms-read:
    post:
      summary: Mark Private Messages as read
      description: Mark all private messages as read for the current user.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Returns user.inbox.newMessages
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/open-mystery-item:
    post:
      summary: Open the Mystery Item box
      description: Open a mystery item box.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Returns Obtained items in data and a success message
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataWithMessageResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/read-card/{cardType}:
    parameters:
      - name: cardType
        in: path
        required: true
        schema:
          type: string
          enum: [birthday, greeting, nye, thankyou, valentine]
          description: Type of card to read
        description: The of card to read (e.g. birthday, greeting, nye, thankyou, valentine).
    post:
      summary: Read a card
      description: Read a card of the specified type for the current user.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Returns user.items.special, user.flags.cardReceived and a success message
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataWithMessageResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/change-class:
    post:
      summary: Change the class of the authenticated user
      description: |
        User must be at least level 10. \
        If "class" is defined and user.flags.classSelected is false it'll change the class. \
        If user.preferences.disableClasses it'll enable classes, otherwise it sets user.flags.classSelected to false (costs 3 gems). \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UserChangeClass)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: class
          in: query
          description: The new class to change to
          required: true
          schema:
            type: string
            enum: [warrior, rogue, wizard, healer]
      responses:
        "200":
          description: User class changed successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/disable-classes:
    post:
      summary: Disable Classes
      description: Disable the classes feature for the user.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: User classes disabled successfully
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/messages:
    delete:
      summary: Delete all messages
      description: |
        Delete all user messages. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-clearMessages)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/messages/{id}:
    parameters:
      - name: id
        in: path
        description: ID of the message to delete
        required: true
        schema:
          type: string
          format: uuid
    delete:
      summary: Delete User Message
      description: Delete a user message by its ID.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (Contains all user.inbox.messages)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/custom-day-start:
    post:
      summary: Set Custom Day Start time for user
      description: Set the custom day start time for a user.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CustomDayStartRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (Value provided is not a number or is outside the range of 0-23)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/purchase/{type}/{key}:
    parameters:
      - name: type
        in: path
        required: true
        schema:
          type: string
          enum:
            [
              gems,
              eggs,
              hatchingPotions,
              premiumHatchingPotions,
              food,
              quests,
              gear,
              pets,
            ]
          default: food
        description: Type of item to purchase. Can be gems, eggs, hatchingPotions, premiumHatchingPotions, food, quests, gear, or pets.
      - name: key
        in: path
        required: true
        schema:
          type: string
        description: Item's key (use "gem" for purchasing gems).
    post:
      summary: Purchase Gem or Gem-purchasable item
      description: Purchase a Gem-purchasable item of the specified type using the provided key.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PurchaseItemRequest"
      responses:
        "200":
          description: Item purchased successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataWithMessageResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/purchase-hourglass/{type}/{key}:
    parameters:
      - name: type
        in: path
        required: true
        schema:
          type: string
          enum: [pets, mounts]
          default: pets
          description: The type of item to purchase.
      - name: key
        in: path
        required: true
        schema:
          type: string
        description: The key for the mount/pet.
    post:
      summary: Purchase Hourglass-purchasable item
      description: Purchases an Hourglass-purchasable item. Does not include Mystery Item sets (use /api/v3/user/buy-mystery-set/{key}).
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/PurchaseItemRequest"
      responses:
        "200":
          description: Hourglass item purchased successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataWithMessageResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/buy-health-potion:
    post:
      summary: Buy a health potion
      description: Purchase a health potion.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (Not enough gold for the purchase or health is already full)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/buy-mystery-set/{key}:
    parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
        description: The key of the mystery set to be purchased.
    post:
      summary: Buy a Mystery Item set
      description: Purchase a Mystery Item set using an Hourglass.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (Not enough Mystic Hourglasses or specified item doesn't exist or already owned)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/buy/{key}:
    parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
        description: The item to buy
    post:
      summary: Buy gear, armoire or potion
      description: |
        Under the hood uses UserBuyGear, UserBuyPotion and UserBuyArmoire \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UserBuy)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (Not enough gold for the purchase or already own equipment)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/buy-gear/{key}:
    parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
        description: The key of the gear to be purchased.
    post:
      summary: Buy a piece of gear
      description: Purchase a piece of gear.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (Not enough gold for the purchase or already own equipment)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/buy-special-spell/{key}:
    parameters:
      - name: key
        in: path
        required: true
        description: The special item to buy. Must be one of the keys from "content.special", such as birthday, snowball, salt.
        schema:
          type: string
          example: "snowball"
    post:
      summary: Buy special item (card, avatar transformation)
      description: |
        Includes gift cards (e.g., birthday card), and avatar Transformation Items and their antidotes (e.g., Snowball item and Salt reward). \
        See: [ApiDocs](https://habitica.com/apidoc/#api-User-UserBuySpecialSpell)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/buy-quest/{key}:
    parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
        description: The key of the quest to be purchased.
    post:
      summary: Buy a quest with gold
      description: Purchase a quest with gold.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (Specified quest does not exist or not enough gold for the purchase)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/buy-armoire:
    post:
      summary: Buy Enchanted Armoire
      description: Purchase an Enchanted Armoire item.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (Not enough gold for the purchase)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/sell/{type}/{key}:
    parameters:
      - name: type
        in: path
        description: The type of item to sell
        required: true
        schema:
          type: string
          enum: [eggs, hatchingPotions, food]
        example: eggs
      - name: key
        in: path
        description: The key of the item
        required: true
        schema:
          type: string
    post:
      summary: Sell a gold-sellable item owned by the user
      description: Sell a specific item of a given type from the user's inventory.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: amount
          in: query
          description: The amount to sell
          required: false
          schema:
            type: number
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v4/user/unequip/{type}:
    parameters:
      - name: type
        in: path
        description: Type of the item to be unequipped
        required: true
        schema:
          type: string
          enum: [pet-mount-background, costume, equipped]
        example: costume
    post:
      summary: Unequip all items by type
      description: Unequip all items by type
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataWithMessageResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/unlock:
    post:
      summary: Unlock item or set of items by purchase
      description: "See: [ApiDoc](https://habitica.com/apidoc/#api-User-UserUnlock)"
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: path
          in: query
          description: Full path to unlock. See "content" API call for list of items
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/allocate:
    post:
      summary: Allocate a single Stat Point
      description: |
        Put a single Stat Point into a specific stat. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UserAllocate)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: stat
          in: query
          description: The stat to increase (str, con, int, or per)
          required: true
          schema:
            type: string
            enum: [str, con, int, per]
      responses:
        "200":
          description: Stat Point allocated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/allocate-now:
    post:
      summary: Allocate all Stat Points
      description: |
        "Uses the user's chosen automatic allocation method, or if none, assigns all to STR. Note: will return success, even if there are 0 points to allocate." \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UserAllocateNow)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Stat points allocated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/allocate-bulk:
    post:
      summary: Allocate multiple Stat Points
      description: Allocate multiple stat points for the authenticated user.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/StatAllocation"
      responses:
        "200":
          description: Stat points allocated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/reroll:
    post:
      summary: Reroll user stats
      description: Reroll a user (reset tasks) using the Fortify Potion.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: User stats rerolled successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/revive:
    post:
      summary: Revive user from death
      description: |
        Revive the authenticated user, restoring health and removing any penalties.  \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UserRevive)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/rebirth:
    post:
      summary: Use Orb of Rebirth on user
      description: |
        Rebirth the authenticated user, resetting their stats and granting rewards. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UserRebirth)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              example:
                error: Authentication failed. Please provide valid userId and apiToken.
  /v4/user/purchase-history:
    get:
      summary: Get user purchase history
      description: |
        Retrieve the purchase history for the authenticated user. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UserGetPurchaseHistory)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/reset:
    post:
      summary: Reset user
      description: |
        Reset the authenticated user's data, removing all progress and starting over.  \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UserReset)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/block/{uuid}:
    parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The UUID of the user to block.
    post:
      summary: Block / unblock a user from sending you a PM
      description: |
        Block / unblock a user from sending you a PM. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-BlockUser)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (Invalid UUID)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/inbox/messages:
    get:
      summary: Get Inbox Messages
      description: Get inbox messages for a user.
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: page
          in: query
          schema:
            type: integer
          description: Load the messages of the selected Page - 10 Messages per Page
        - name: conversation
          in: query
          schema:
            type: string
            format: uuid
          description: Loads only the messages of a conversation
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/auth/update-username:
    put:
      summary: Update User's Username
      description: |
        Update the username associated with current user's account. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UpdateUsername)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateUsernameRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/auth/update-email:
    put:
      summary: Update email
      description: |
        Change the user email address. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UpdateEmail)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdateEmailRequest"
      responses:
        "200":
          description: OK (email field, the updated email address)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/auth/update-password:
    put:
      summary: Update password
      description: |
        Update the password of a local user. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-User-UpdatePassword)
      tags:
        - user
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UpdatePasswordRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/user:
    get:
      summary: Get user's tasks
      description: Retrieve all tasks for the authenticated user.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: type
          in: query
          required: false
          description: Optional query parameter to return just a type of tasks. By default all types will be returned except completed todos that must be requested separately. The "completedTodos" type returns only the 30 most recently completed.
          schema:
            type: string
            enum: [habits, dailys, todos, rewards, completedTodos]
        - name: dueDate
          in: query
          required: false
          description: Optional date to use for computing the nextDue field for each returned task.
          schema:
            type: string
            format: date
      responses:
        "200":
          description: OK (data contains an array of tasks)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    post:
      summary: Create a new task belonging to the user
      description: Can be passed an object to create a single task or an array of objects to create multiple tasks.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/UserTaskRequest"
      responses:
        "201":
          description: Task created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/clearCompletedTodos:
    post:
      summary: Delete user's completed todos
      description: Deletes all of a user's completed To Do's except those belonging to active Challenges and Group Plans.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/looking-for-party:
    get:
      summary: Get users in search of parties
      description: |
        Get users who are looking for a party. \
        *You must be the leader of a party to be able to use this endpoint.* \
        See: [ApiDoc](https://habitica.com/apidoc/#api-Group-GetLookingForParty)
      tags:
        - party
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: number
            default: 0
          description: Page number, defaults to 0.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (You are not the leader of a Party)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups:
    get:
      summary: Get user's groups
      description: Retrieve information about groups associated with the user.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: type
          in: query
          description: Type of groups to retrieve (party, guilds, privateGuilds, publicGuilds, tavern)
          required: true
          schema:
            type: string
            enum:
              - party
              - guilds
              - privateGuilds
              - publicGuilds
              - tavern
          example: party
        - name: paginate
          in: query
          description: Whether to paginate the results (true or false)
          schema:
            type: boolean
          example: false
        - name: page
          in: query
          description: Page number for paginated results (if paginate is true)
          schema:
            type: integer
            minimum: 1
          example: 1
      responses:
        "200":
          description: User's groups retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    post:
      summary: Create a Group
      description: |
        Create a group in Habitica. \
        Possible types: `guild` or `party` \
        Possible privacy: `public` or `private` (party MUST be private)
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateOrUpdateGroupRequest"
      responses:
        "201":
          description: Group created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}:
    parameters:
      - name: groupId
        in: path
        description: The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)
        required: true
        schema:
          type: string
    get:
      summary: Get group information
      description: |
        Retrieve information about a specific group. \
        Use `party` as the {groupId} for user's party \
        Or 'habitrpg' for the tavern group
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Group not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    put:
      summary: Update Group
      description: |
        Update a group. \
        **Required Permissions:** `GroupLeader`, `Admin`
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateOrUpdateGroupRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/members:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group id ('party' for the user party is accepted)
    get:
      summary: Get members for a group
      description: With a limit of 30 member per request (by default). To get all members run requests against this routes (updating the lastId query parameter) until you get less than 30 results (or the specified limit).
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: lastId
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Query parameter to specify the last member returned in a previous request to this route and get the next batch of results.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 60
            default: 30
          description: BETA Query parameter to specify the number of results to return. Max is 60.
        - name: includeTasks
          in: query
          required: false
          schema:
            type: boolean
          description: BETA Query parameter - If 'true' then include challenge tasks of each member.
        - name: includeAllPublicFields
          in: query
          required: false
          schema:
            type: boolean
          description: If set to true then all public fields for members will be returned (similar to when making a request for a single member).
      responses:
        "200":
          description: OK (data is an array of members, sorted by _id)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Group not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/invites:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group id ('party' for the user party is accepted)
    get:
      summary: Get invites for a group
      description: With a limit of 30 member per request (by default). To get all invites run requests against this routes (updating the lastId query parameter) until you get less than 30 results.
      tags:
        - groups
      parameters:
        - name: lastId
          in: query
          schema:
            type: string
            format: uuid
          description: Query parameter to specify the last invite returned in a previous request to this route and get the next batch of results.
        - name: limit
          in: query
          schema:
            type: integer
            default: 30
            maximum: 60
          description: BETA Query parameter to specify the number of results to return. Max is 60.
        - name: includeAllPublicFields
          in: query
          schema:
            type: boolean
            default: false
          description: If set to `true` then all public fields for members will be returned (similar to when making a request for a single member).
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/add-manager:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)
    post:
      summary: Add Group Manager
      description: Add a new manager to the specified group.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddOrRemoveManagerRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/remove-manager:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)
    post:
      summary: Remove a manager from a group
      description: Remove a manager from a group.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddOrRemoveManagerRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/invite:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)
    post:
      summary: Invite users to a group
      description: |
        Invite a user to join a group. \
        You can provide both `emails` and `uuids`, or just one. You must provide at least one.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GroupInviteRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/removeMember/{memberId}:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)
      - name: memberId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The ID of the member to be removed from the group.
      - name: message
        in: query
        required: false
        schema:
          type: string
        description: The message to send to the removed members.
    post:
      summary: Remove a member from a group
      description: Remove a member from a group.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/join:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)
    post:
      summary: Join a group
      description: Join a group.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (A groupId is required or Group requires an invitation to join (e.g. private group, party))
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (The specified group could not be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/leave:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)
      - name: keep
        in: query
        required: false
        schema:
          type: string
          enum:
            - remove-all
            - keep-all
          default: keep-all
        description: Specify whether to remove or keep challenges when leaving the group.
    post:
      summary: Leave a group
      description: Leave a group.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LeaveGroupRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (The specified group could not be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/reject-invite:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id ('party' for the user party and 'habitrpg' for tavern are accepted)
    post:
      summary: Reject a group invitation
      description: Reject an invitation to join a group.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/quests/accept:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id (or 'party')
    post:
      summary: Accept Group Quest
      description: Accept a pending group (party) quest.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (Group or Quest not found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/quests/reject:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id (or 'party')
    post:
      summary: Reject Group Quest
      description: Reject a pending group (party) quest.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (Group or Quest not found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/quests/leave:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id (or 'party')
    post:
      summary: Leave Group Quest
      description: Leave the ongoing quest.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Successfully left the group quest
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (Group or Quest not found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/quests/cancel:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id (or 'party')
    post:
      summary: Cancel Group Quest
      description: |
        Cancel current not active quest. \
        **Required Permissions:** `QuestLeader` or `GroupLeader`.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (Group or Quest not found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/quests/abort:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id (or 'party')
    post:
      summary: Abort Group Quest
      description: |
        Abort the active group quest. \
        **Required Permissions:** `QuestLeader` or `GroupLeader`.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Group quest aborted successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (Group or Quest not found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/quests/force-start:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id (or 'party')
    post:
      summary: Force-Start Group Quest
      description: |
        Force-start the quest, allowing the quest to begin immediately. \
        **Required Permissions:** `QuestLeader` or `GroupLeader`.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (Group or Quest not found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/quests/invite/{questKey}:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group _id (or 'party')
      - name: questKey
        in: path
        required: true
        schema:
          type: string
        description: The unique key of the quest.
    post:
      summary: Invite users to a quest
      description: Send a quest invitation to a user to join a group quest.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (Group or Quest not found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/group-plans:
    get:
      summary: Get Group Plans
      description: Get a list of available group plans.
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (An array of the requested groups with a group plan (See [/website/server/models/group.js](https://github.com/HabitRPG/habitica/blob/develop/website/server/models/group.js)))
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/create-plan:
    post:
      summary: Create Group Plan
      description: |
        Create a new group plan. \
        *The official Habitica Doc doesn't provide infomation about the request body, it might be wrong.*
      tags:
        - groups
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/GroupPlanCreateRequest"
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/party/chat:
    get:
      summary: Get party chat messages
      description: Retrieve the chat messages from the party's chat.
      tags:
        - chat
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (data is an array of chat messages)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    post:
      summary: Send a chat message to the party
      description: Send a chat message in the party's chat.
      tags:
        - chat
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: previousMsg
          in: query
          required: false
          schema:
            type: string
          description: The previous chat message's UUID which will force a return of the full group chat.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ChatMessageRequest"
      responses:
        "201":
          description: Created (Sent message)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request  (Your chat privileges have been revoked or the group ID is invalid)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (No party found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/chat:
    parameters:
      - name: groupId
        in: path
        description: The group id ('party' for the user party and 'habitrpg' for tavern are accepted)
        required: true
        schema:
          type: string
    get:
      summary: Get group chat messages
      description: Retrieve the chat messages from the group's chat.
      tags:
        - chat
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (data is an array of chat messages)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    post:
      summary: Send a chat message in a group
      description: Send a chat message in the specified group's chat.
      tags:
        - chat
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: previousMsg
          in: query
          required: false
          schema:
            type: string
          description: The previous chat message's UUID which will force a return of the full group chat.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ChatMessageRequest"
      responses:
        "201":
          description: Created (Sent message)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request  (Your chat privileges have been revoked or the group ID is invalid)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (The specified group could not be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/chat/{chatId}:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
          description: The group id ('party' for the user party and 'habitrpg' for tavern are accepted)
      - name: chatId
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The UUID of the chat message to delete.
    delete:
      summary: Delete chat message from a group
      description: Delete's a chat message from a group.
      tags:
        - chat
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: previousMsg
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: The last message's ID fetched by the client so that the whole chat will be returned only if new messages have been posted in the meantime.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (The specified group or message could't be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/chat/{chatId}/like:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
          description: The group id ('party' for the user party and 'habitrpg' for tavern are accepted)
      - name: chatId
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The UUID of the chat message to like.
    post:
      summary: Like Group Chat Message
      description: Like a message in the group chat of a specific group.
      tags:
        - chat
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (A user can't like his own message, invalid group or chat ID)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (The specified group or message could't be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/chat/seen:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
          description: The group id ('party' for the user party and 'habitrpg' for tavern are accepted)
    post:
      summary: Mark Group Chat Messages as Seen
      description: Mark all chat messages in a group as seen.
      tags:
        - chat
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Chat messages marked as seen successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/chat/{chatId}/flag:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group id ('party' for the user party and 'habitrpg' for tavern are accepted).
      - name: chatId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The chat message id.
    post:
      summary: Flag a group chat message
      description: A message will be hidden from chat if two or more users flag a message. It will be hidden immediately if a moderator flags the message. An email is sent to the moderators about every flagged message.
      tags:
        - chat
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ChatFlagRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/groups/{groupId}/chat/{chatId}/clearflags:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
          description: The group id ('party' for the user party and 'habitrpg' for tavern are accepted)
      - name: chatId
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The UUID of the chat message to clear flags from.
    post:
      summary: Clear flags
      description: |
        Resets the flag count on a chat message. Retains the id of the user's that have flagged the message. (Only visible to moderators). \
        **Required Permissions:** Habitica `Admin`
      tags:
        - chat
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Chat flags cleared successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (Group ID or Chat ID are missing)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (Insufficient Permissions or Group ID or Chat ID couldn't be find)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/challenges:
    post:
      summary: Create a challenge
      description: Create a new challenge.
      tags:
        - challenges
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ChallengeRequest"
      responses:
        "200":
          description: Challenge created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "201":
          description: The newly created challenge
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (Invalid or missing parameter in challenge body)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized (Not Authorized or User does not have enough gems to offer this prize)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (Group or User not found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/challenges/user:
    get:
      summary: Get challenges for a user
      description: Get challenges the user has access to. Includes public challenges, challenges belonging to the user's group, and challenges the user has already joined. Returns 10 results per page.
      tags:
        - challenges
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: page
          in: query
          description: This parameter can be used to specify the page number for the user challenges result (the initial page is number 0).
          required: true
          schema:
            type: number
            example: 0
        - name: member
          in: query
          description: If set to true it limits results to challenges where the user is a member.
          required: false
          schema:
            type: string
        - name: owned
          in: query
          description: If set to owned it limits results to challenges owned by the user. If set to not_owned it limits results to challenges not owned by the user.
          required: false
          schema:
            type: string
        - name: search
          in: query
          description: Optional query parameter to filter results to challenges that include (even partially) the search query parameter in the name or description.
          required: false
          schema:
            type: string
        - name: categories
          in: query
          description: Optional comma separated list of categories. If set it limits results to challenges that are part of the given categories.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: User challenges retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (Page query parameter must be a positive integer)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (User could not be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/challenges/{challengeId}:
    parameters:
      - name: challengeId
        in: path
        description: ID of the challenge to retrieve
        required: true
        schema:
          type: string
          format: uuid
    get:
      summary: Get challenges for a group
      description: Get challenges hosted in the specified group.
      tags:
        - challenges
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Challenge retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "404":
          description: Challenge not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    put:
      summary: Update a challenge
      description: |
        Update a challenge's name, description, or summary. \
        **Required Permission:** `ChallengeLeader`
      tags:
        - challenges
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ChallengeUpdateRequest"
      responses:
        "200":
          description: Challenge updated successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Challenge not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    delete:
      summary: Delete a challenge
      description: Delete the specified challenge by challenge ID.
      tags:
        - challenges
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Challenge deleted successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Challenge not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/challenges/{challengeId}/join:
    parameters:
      - name: challengeId
        in: path
        description: ID of the challenge
        required: true
        schema:
          type: string
          format: uuid
    post:
      summary: Join a challenge
      description: Join the specified challenge.
      tags:
        - challenges
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Challenge joined successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Challenge not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/challenges/{challengeId}/leave:
    parameters:
      - name: challengeId
        in: path
        description: ID of the challenge to leave
        required: true
        schema:
          type: string
          format: uuid
    post:
      summary: Leave Challenge
      description: Leave a challenge by its ID.
      tags:
        - challenges
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/LeaveChallengeRequest"
      responses:
        "200":
          description: Successfully left the challenge
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Challenge not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/challenges/{challengeId}/clone:
    parameters:
      - name: challengeId
        in: path
        description: ID of the challenge to clone
        required: true
        schema:
          type: string
          format: uuid
    post:
      summary: Clone a challenge
      description: Create a clone of the specified challenge by challenge ID.
      tags:
        - challenges
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Challenge cloned successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Challenge not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/challenges/{challengeId}/export/csv:
    parameters:
      - name: challengeId
        in: path
        description: ID of the challenge to export
        required: true
        schema:
          type: string
          format: uuid
    get:
      summary: Export Challenge to CSV
      description: Export the specified challenge to a CSV file.
      tags:
        - challenges
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: CSV exported successfully
          content:
            text/csv:
              schema:
                type: string
                format: binary
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Challenge not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/challenges/groups/{groupId}:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group id ('party' for the user party and 'habitrpg' for tavern are accepted).
    get:
      summary: Get challenges for a group
      description: Get challenges hosted in the specified group.
      tags:
        - challenges
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/challenges/{challengeId}/members:
    parameters:
      - name: challengeId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The UUID of the challenge whose members are to be retrieved.
    get:
      summary: Get members for a challenge
      description: With a limit of 30 member per request (by default). To get all members run requests against this routes (updating the lastId query parameter) until you get less than 30 results. BETA You can also use ?includeAllMembers=true. This option is currently in BETA and may be removed in future. Its use is discouraged and its performances are not optimized especially for large challenges.
      tags:
        - challenges
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: lastId
          in: query
          required: false
          schema:
            type: string
            format: uuid
          description: Query parameter to specify the last member returned in a previous request to this route and get the next batch of results.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 60
            default: 30
          description: BETA Query parameter to specify the number of results to return. Max is 60.
        - name: includeTasks
          in: query
          required: false
          schema:
            type: boolean
          description: BETA Query parameter - If 'true' then include challenge tasks of each member.
        - name: includeAllPublicFields
          in: query
          required: false
          schema:
            type: boolean
          description: If set to true then all public fields for members will be returned (similar to when making a request for a single member).
      responses:
        "200":
          description: OK (data is an array of members, sorted by _id)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Challenge not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/challenges/{challengeId}/members/{memberId}:
    parameters:
      - name: challengeId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The ID of the challenge.
      - name: memberId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The ID of the challenge member.
    get:
      summary: Get a challenge member progress
      description: Get a challenge member progress.
      tags:
        - challenges
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/challenges/{challengeId}/selectWinner/{winnerId}:
    parameters:
      - name: challengeId
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The Challenge ID for the challenge to close with a winner.
      - name: winnerId
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The User ID of the winning user.
    post:
      summary: Select Challenge Winner
      description: Select winner for a challenge.
      tags:
        - challenges
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (The challenge or the user could't be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/webhook:
    get:
      summary: Get user webhooks
      description: Retrieve all webhooks registered by the authenticated user.
      tags:
        - webhook
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    post:
      summary: Create user webhook
      description: |
        Create a new webhook for the authenticated user. \
        Possible types: `taskActivity`, `groupChatReceived`, `userActivity`, `questActivity`
      tags:
        - webhook
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookCreateRequest"
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/user/webhook/{id}:
    parameters:
      - name: id
        in: path
        description: Id (UUID) of the webhook to retrieve
        required: true
        schema:
          type: string
          format: uuid
    put:
      summary: Edit a webhook
      description: Can change `url`, `enabled`, `type`, and `options` properties. Cannot change `id`.
      tags:
        - webhook
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/WebhookUpdateRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Webhook not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    delete:
      summary: Delete a webhook
      description: Delete a specific webhook by webhook ID.
      tags:
        - webhook
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (data is an array of all remaining WebHooks)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Webhook not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/models/{model}/paths:
    parameters:
      - name: model
        in: path
        description: Model name
        required: true
        schema:
          type: string
          enum:
            - user
            - group
            - challenge
            - tag
            - habit
            - daily
            - todo
            - reward
        example: user
    get:
      summary: Get paths for a specific model
      description: Retrieve the paths associated with the specified model.
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Model not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/hall/heroes:
    get:
      summary: Get all Heroes (contributors)
      description: Returns an array of objects containing the heroes who have contributed for Habitica. The array is sorted by the contribution level in descending order.
      tags:
        - hall
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/hall/patrons:
    parameters:
      - name: page
        in: query
        schema:
          type: integer
          default: 0
        description: Page number for pagination (optional)
    get:
      summary: Get all patrons
      description: Returns an array of objects containing the patrons who backed Habitica's original kickstarter. The array is sorted by the backer tier in descending order. By default, only the first 50 patrons are returned. More can be accessed by passing ?page=n.
      tags:
        - hall
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/hall/heroes/party/{groupId}:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group id ('party' for the user party and 'habitrpg' for tavern are accepted)
    get:
      summary: Get any Party given its ID
      description: |
        Returns some basic information about a given Party, to assist admins with user support. \
        **Required Permissions:** `userSupport`
      tags:
        - hall
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/hall/heroes/{heroId}:
    parameters:
      - name: heroId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The ID of the hero
    get:
      summary: Get any user ("hero") given the UUID or Username
      description: |
        Returns various data about the user. User does not need to be a contributor. \
        **Required Permissions:** `Admin`
      tags:
        - hall
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    put:
      summary: Update any user ("hero")
      description: |
        Update various details in the user's User document, including but not limited to privileges, gems, contributions, items. \
        **Required Permissions:** `Admin`
      tags:
        - hall
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/HeroUpdateRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/news:
    get:
      summary: Get latest Bailey announcement
      description: Get latest Bailey announcement as HTML
      tags:
        - news
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/NewsResponse"
  /v4/news/read:
    post:
      summary: Mark the latest Bailey announcement as read
      description: Mark the latest Bailey announcement as read
      tags:
        - news
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: News articles marked as read successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/news/tell-me-later:
    post:
      summary: Allow latest Bailey announcement to be read later
      description: Add a notification to allow viewing of the latest "New Stuff by Bailey" message. Prevent this specific Bailey message from appearing automatically
      tags:
        - news
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: Request to be notified later successful
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v4/news:
    post:
      summary: Create news article
      description: Create a new news article in the Habitica application.
      tags:
        - news
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NewsPost"
      responses:
        "200":
          description: News article created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v4/news/{postId}:
    parameters:
      - name: postId
        in: path
        description: ID of the news post to retrieve
        required: true
        schema:
          type: string
          format: uuid
    get:
      summary: Get news post by ID
      description: Retrieve a news post by its ID.
      tags:
        - news
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"

        "404":
          description: News post not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    put:
      summary: Update news post by ID
      description: Update a news post by its ID.
      tags:
        - news
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/NewsPost"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: News post not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    delete:
      summary: Delete news post by ID
      description: Delete a news post by its ID.
      tags:
        - news
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: News post not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/notifications/read:
    post:
      summary: Mark Notifications as Read
      description: Mark all notifications as read.
      tags:
        - notifications
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (Notifications marked as read successfully, returns user.notifications)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/notifications/see:
    post:
      summary: Mark Notifications as Seen
      description: Mark all notifications as seen.
      tags:
        - notifications
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (Notifications marked as seen successfully, returns user.notifications)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/notifications/{notificationId}/read:
    parameters:
      - name: notificationId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The ID of the notification to mark as read.
    post:
      summary: Mark Notification as Read
      description: Mark a specific notification as read.
      tags:
        - notifications
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (Notification marked as read successfully, returns user.notifications)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/notifications/{notificationId}/see:
    parameters:
      - name: notificationId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The ID of the notification to mark as seen.
    post:
      summary: Mark Notification as Seen
      description: Mark a specific notification as seen.
      tags:
        - notifications
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (Notification marked as seen successfully, returns user.notifications)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/{taskId}:
    parameters:
      - name: taskId
        in: path
        required: true
        description: The task _id or alias
        schema:
          type: string
    get:
      summary: Get a task
      description: |
        Retrieve a task by its id. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-Task-GetTask)
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Task"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    put:
      summary: Update a task
      description: |
        Update the details of a task. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-Task-UpdateTask)
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Task"
      responses:
        "200":
          description: OK (The updated task)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/SuccessResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Fround (Task not found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    delete:
      summary: Delete a task
      description: |
        Delete a task. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-Task-DeleteTask)
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/{taskId}/tags/{tagId}:
    parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The task _id or alias
      - name: tagId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The tag id
    post:
      summary: Add a tag to a task
      description: Add a tag to a specific task.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    delete:
      summary: Delete a tag from a task
      description: Remove a tag from a task.
      tags:
        - tasks
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/{taskId}/checklist:
    parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The task _id or alias
    post:
      summary: Add an item to the task's checklist
      description: Add an item to the checklist of a specific task.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ChecklistItemRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/{taskId}/checklist/{itemId}:
    parameters:
      - name: taskId
        in: path
        required: true
        description: The task _id or alias
        schema:
          type: string
      - name: itemId
        in: path
        required: true
        description: The checklist item _id
        schema:
          type: string
          format: uuid
    put:
      summary: Update a checklist item
      description: Update the details of a checklist item in a task.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ChecklistItemRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (Task or checklist item not found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    delete:
      summary: Delete a checklist item from a task
      description: Delete a checklist item from a task.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"

  /v3/tasks/{taskId}/assign:
    parameters:
      - name: taskId
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The id of the task that will be assigned
    post:
      summary: Assign a group task to a user or users
      description: Assign users to a group task.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TaskAssignRequest"
      responses:
        "200":
          description: OK (The assigned task)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/challenge/{challengeId}:
    parameters:
      - name: challengeId
        in: path
        required: true
        description: The id of the challenge
        schema:
          type: string
          format: uuid
    get:
      summary: Get a challenge's tasks
      description: Retrieve tasks associated with a specific challenge.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: type
          in: query
          required: false
          description: Query parameter to return just a type of tasks.
          schema:
            type: string
            enum: [habits, dailys, todos, rewards]
      responses:
        "200":
          description: OK (An array of tasks)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Task"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    post:
      summary: Create a new task belonging to a challenge
      description: Can be passed an object to create a single task or an array of objects to create multiple tasks.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Task"
      responses:
        "201":
          description: Created
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/group/{groupId}:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group id ('party' for the user party and 'habitrpg' for tavern are accepted)
    get:
      summary: Get a group's tasks
      description: Retrieve tasks associated with a specific group.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: type
          in: query
          required: false
          description: Query parameter to return just a type of tasks.
          schema:
            type: string
            enum: [habits, dailys, todos, rewards]
      responses:
        "200":
          description: OK (An array of tasks)
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Task"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    post:
      summary: Create a new task belonging to a group
      description: Can be passed an object to create a single task or an array of objects to create multiple tasks.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Task"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/{taskId}/move/to/{position}:
    parameters:
      - name: taskId
        in: path
        required: true
        description: The task _id or alias
        schema:
          type: string
      - name: position
        in: path
        required: true
        description: Where to move the task. 0 = top of the list ("push to top"). -1 = bottom of the list ("push to bottom")
        schema:
          type: integer
    post:
      summary: Move a task to a new position
      description: |
        Note: completed To Do's are not sortable, do not appear in user.tasksOrder.todos, and are ordered by date of completion. \
        See [ApiDoc](https://habitica.com/apidoc/#api-Task-MoveTask)
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (The new tasks order for the specific type that the taskID belongs to)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/group/{groupId}/tasks/{taskId}/move/to/{position}:
    parameters:
      - name: groupId
        in: path
        required: true
        schema:
          type: string
        description: The group id ('party' for the user party and 'habitrpg' for tavern are accepted)
      - name: taskId
        in: path
        required: true
        description: The task _id or alias
        schema:
          type: string
          format: uuid
      - name: position
        in: path
        required: true
        description: Where to move the task. 0 = top of the list ("push to top"). -1 = bottom of the list ("push to bottom")
        schema:
          type: integer
    post:
      summary: Move a group task to a specified position
      description: See [ApiDoc](https://habitica.com/apidoc/#api-Task-GroupMoveTask)
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (The new tasks order (group.tasksOrder.{task.type}s))
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/{taskId}/needs-work/{userId}:
    parameters:
      - name: taskId
        in: path
        required: true
        description: The id pr alies of the task that is the original group task
        schema:
          type: string
      - name: userId
        in: path
        required: true
        description: The id of the assigned user
        schema:
          type: string
          format: uuid
    post:
      summary: Require more work for a group task
      description: Mark an assigned group task as needing more work before it can be approved
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (The task that needs more work)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/{taskId}/checklist/{itemId}/score:
    parameters:
      - name: taskId
        in: path
        required: true
        description: The task _id or alias
        schema:
          type: string
      - name: itemId
        in: path
        required: true
        description: The checklist item _id
        schema:
          type: string
          format: uuid
    post:
      summary: Score a checklist item
      description: Score a checklist item within a task.
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/{taskId}/score/{direction}:
    parameters:
      - name: taskId
        in: path
        required: true
        description: The task _id or alias
        schema:
          type: string
      - name: direction
        in: path
        required: true
        description: The direction for scoring the task (up or down).
        schema:
          type: string
          enum: [up, down]
          default: up
    post:
      summary: Score a task
      description: Score a task in the specified direction (up or down).
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "202":
          description: Accepted (Approval was requested for team task)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/{taskId}/unassign/{assignedUserId}:
    parameters:
      - name: taskId
        in: path
        required: true
        description: The id of the task that is the original group task
        schema:
          type: string
          format: uuid
      - name: assignedUserId
        in: path
        required: true
        description: The id of the user that will be unassigned from the task
        schema:
          type: string
          format: uuid
    post:
      summary: Unassign a user from a task
      description: |
        Unassigns a user from a group task \
        See: [ApiDoc](https://habitica.com/apidoc/#api-Task-UnassignTask)
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK (The unassigned task)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /tasks/unlink-one/{taskId}:
    parameters:
      - name: taskId
        in: path
        required: true
        description: The task _id or alias
        schema:
          type: string
    post:
      summary: Unlink a challenge task
      description: |
        Unlink a challenge task \
        See: [ApiDoc](https://habitica.com/apidoc/#api-Task-UnlinkOneTask)
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: keep
          in: query
          required: false
          description: Specifies if the task should be kept(keep) or removed(remove)
          schema:
            type: string
            enum: [keep, remove]
            default: remove
      responses:
        "200":
          description: OK (An empty object)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tasks/unlink-all/{challengeId}:
    parameters:
      - name: challengeId
        in: path
        required: true
        description: The challenge _id
        schema:
          type: string
          format: uuid
    post:
      summary: Unlink all tasks from a challenge
      description: |
        Unlink all tasks associated with a specific challenge in Habitica. \
        See: [ApiDoc](https://habitica.com/apidoc/#api-Task-UnlinkAllTasks)
      tags:
        - tasks
      security:
        - userId: []
          apiToken: []
          xClient: []
      parameters:
        - name: keep
          in: query
          required: true
          description: Specifies if tasks should be kept(keep-all) or removed(remove-all) after the unlink.
          schema:
            type: string
            enum: [keep-all, remove-all]
            default: remove-all
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Challenge not found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tags:
    get:
      summary: Get all user's tags
      description: Get the list of tags for the user's tasks in Habitica.
      tags:
        - tags
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    post:
      summary: Create a new tag
      description: Create a new tag for the user's tasks in Habitica.
      tags:
        - tags
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TagCreateOrUpdateRequest"
      responses:
        "201":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/tags/{tagId}:
    parameters:
      - name: tagId
        in: path
        required: true
        schema:
          type: string
          format: uuid
          description: The ID of the tag.
    get:
      summary: Get a Tag
      description: Get the details of a specific tag for the user's tasks in Habitica.
      tags:
        - tags
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request ("tagId" must be a valid UUID corresponding to a tag belonging to the user.)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (The specified tag could not be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    put:
      summary: Update Tag
      description: Update the details of a specific tag for the user's tasks in Habitica.
      tags:
        - tags
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TagCreateOrUpdateRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request ("tagId" must be a valid UUID corresponding to a tag belonging to the user)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (The specified tag could not be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
    delete:
      summary: Delete a user tag
      description: Delete a specific tag for the user's tasks in Habitica.
      tags:
        - tags
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request ("tagId" must be a valid UUID corresponding to a tag belonging to the user)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (The specified tag could not be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/reorder-tags:
    post:
      summary: Reorder Tags
      description: |
        Reorder the user's tags for tasks in Habitica. \
        **tagId**: Id of the tag to move \
        **to**: Position the tag is moving to
      tags:
        - tags
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TagReorderRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found (The specified tag could not be found)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/coupons/generate/{event}:
    parameters:
      - name: event
        in: path
        required: true
        schema:
          type: string
          enum: [wondercon, google_6mo]
        description: The event for which the coupon should be generated.
      - name: count
        in: query
        schema:
          type: number
        description: The number of coupon codes to generate.
    post:
      summary: Generate Coupons for Event
      description: |
        Generate coupons for an event in Habitica. \
        **Required Permission:** `sudo` *(whatever it means)*
      tags:
        - coupons
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request (The request was missing the count query parameter or used an invalid event)
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/coupons:
    get:
      summary: Get Coupons
      description: Retrieve a list of available coupons.
      tags:
        - coupons
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: List of available coupons retrieved successfully
          content:
            text/csv:
              schema:
                type: string
                format: binary
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/coupons/enter/{code}:
    parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
        description: The coupon code to apply.
    post:
      summary: Redeem a coupon code
      description: Enter a coupon code to redeem rewards.
      tags:
        - coupons
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/coupons/validate/{code}:
    parameters:
      - name: code
        in: path
        required: true
        schema:
          type: string
        description: The coupon code to validate.
    post:
      summary: Validate a coupon code
      description: Validate a coupon code.
      tags:
        - coupons
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "400":
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /export/userdata.json:
    servers:
      - url: https://habitica.com
    get:
      summary: Export user data in JSON format
      description: Export user data in JSON format.
      tags:
        - data-export
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: string
                format: binary
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /export/userdata.xml:
    servers:
      - url: https://habitica.com
    get:
      summary: Export user data in XML format
      description: Export user data in XML format.
      tags:
        - data-export
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/xml:
              schema:
                type: string
                format: binary
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /export/inbox.html:
    servers:
      - url: https://habitica.com
    get:
      summary: Export Inbox Data in HTML
      description: Export user private messages as HTML document.
      tags:
        - data-export
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            text/html:
              schema:
                type: string
                format: binary
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /export/history.csv:
    servers:
      - url: https://habitica.com
    get:
      summary: Export user tasks history in CSV format
      description: History is only available for habits and dailies so todos and rewards won't be included. Can only be used on https://habitica.com.
      tags:
        - data-export
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            text/csv:
              schema:
                type: string
                format: binary
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /export/avatar-{uuid}.png:
    servers:
      - url: https://habitica.com
    parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The UUID of the user.
    get:
      summary: Render a user avatar as a PNG file
      description: "**This PNG export feature is not currently working (https://github.com/HabitRPG/habitica/issues/9489).**"
      tags:
        - data-export
      responses:
        "200":
          description: OK
          content:
            image/png:
              schema:
                type: string
                format: binary
  /export/avatar-{uuid}.html:
    servers:
      - url: https://habitica.com
    parameters:
      - name: uuid
        in: path
        required: true
        schema:
          type: string
          format: uuid
        description: The UUID of the user.
    get:
      summary: Render a user avatar as an HTML page
      description: "**This HTML export feature is not currently working (https://github.com/HabitRPG/habitica/issues/9489).**"
      tags:
        - data-export
      responses:
        "200":
          description: OK
          content:
            text/html:
              schema:
                type: string
                format: binary
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/debug/add-hourglass:
    post:
      summary: Add Hourglass to the current user
      description: |
        Add an hourglass to the user's account for debugging purposes. \
        **Required Permissions:** `Developers` \
        See: [ApiDoc](https://habitica.com/apidoc/#api-Development-AddHourglass)
      tags:
        - development
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/debug/add-ten-gems:
    post:
      summary: Add ten gems to the current user
      description: |
        Add ten gems to the user's account for debugging purposes. \
        **Required Permissions:** `Developers` \
        See: [ApiDoc](https://habitica.com/apidoc/#api-Development-AddTenGems)
      tags:
        - development
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/debug/quest-progress:
    post:
      summary: Artificially accelerate quest progress
      description: |
        Artificially accelerate quest progress for debugging purposes. \
        **Required Permissions:** `Developers` \
        See: [ApiDoc](https://habitica.com/apidoc/#api-Development-questProgress)
      tags:
        - development
      security:
        - userId: []
          apiToken: []
          xClient: []
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/debug/modify-inventory:
    post:
      summary: Manipulate user's inventory
      description: |
        Modify user's inventory items for debugging purposes. \
        **Required Permissions:** `Developers` \
        See: [ApiDoc](https://habitica.com/apidoc/#api-Development-modifyInventory)
      tags:
        - development
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/InventoryModificationRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
  /v3/debug/set-cron:
    post:
      summary: Set lastCron for user
      description: |
        Set lastCron to the user's account for debugging purposes. \
        **Required Permissions:** `Developers` \
        *The official Habitica Doc hasn't provided any parameters for the request* \
        See: [ApiDocs](https://habitica.com/apidoc/#api-Development-setCron)
      tags:
        - development
      security:
        - userId: []
          apiToken: []
          xClient: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/SetLastCronRequest"
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DataResponse"
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"
        "404":
          description: Not Found
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorMessageResponse"