Habitica

Delete a challenge via DELETE /api/v3/challenges/{challengeId}

Delete's a chat message from a group via DELETE /api/v3/groups/{groupId}/chat/{chatId}

Delete a user tag via DELETE /api/v3/tags/{tagId}

Delete a task via DELETE /api/v3/tasks/{taskId}

Delete a checklist item from a task via DELETE /api/v3/tasks/{taskId}/checklist/{itemId}

Delete a tag from a task via DELETE /api/v3/tasks/{taskId}/tags/{tagId}

Delete an authenticated user's account via DELETE /api/v3/user

Remove a social authentication method from a user profile. The user must have another authentication method enabled. via DELETE /api/v3/user/auth/social/{network}

Delete all messages via DELETE /api/v3/user/messages

Delete a message via DELETE /api/v3/user/messages/{id}

Delete a webhook - BETA via DELETE /api/v3/user/webhook/{id}

Get a challenge via GET /api/v3/challenges/{challengeId}

Export a challenge in CSV via GET /api/v3/challenges/{challengeId}/export/csv

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. via GET /api/v3/challenges/{challengeId}/members

Get a challenge member progress via GET /api/v3/challenges/{challengeId}/members/{memberId}

Get challenges hosted in the specified group. via GET /api/v3/challenges/groups/{groupId}

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. via GET /api/v3/challenges/user

Does not require authentication. via GET /api/v3/content

Get coupons via GET /api/v3/coupons

Get group plans for a user via GET /api/v3/group-plans

Get groups for a user via GET /api/v3/groups

Get group via GET /api/v3/groups/{groupId}

Fetches an array of messages from a group via GET /api/v3/groups/{groupId}/chat

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. via GET /api/v3/groups/{groupId}/invites

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). via GET /api/v3/groups/{groupId}/members

Returns an array of objects containing the heroes who have contributed for Habitica. The array is sorted by the contribution level in descending order. via GET /api/v3/hall/heroes

Returns various data about the user. User does not need to be a contributor. via GET /api/v3/hall/heroes/{heroId}

Returns some basic information about group plans, to assist admins with user support. via GET /api/v3/hall/heroes/{heroId}/group-plans

Returns some basic information about a given Party, to assist admins with user support. via GET /api/v3/hall/heroes/party/{groupId}

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 via GET /api/v3/hall/patrons

Returns the i18n JS script to make all the i18n strings available in the browser under window.i18n.strings. Does not require authentication. via GET /api/v3/i18n/content

Returns the i18n JS script to make all the i18n strings available in the browser under window.i18n.strings. Does not require authentication. via GET /api/v3/i18n/core

Get inbox messages for a user via GET /api/v3/inbox/messages

Get users in search of parties via GET /api/v3/looking-for-party

Get a member profile via GET /api/v3/members/{memberId}

Get a list of achievements of the requested member, grouped by basic / seasonal / special. via GET /api/v3/members/{memberId}/achievements

Get any objections that would occur if the given interaction was attempted - BETA. via GET /api/v3/members/{toUserId}/objections/{interaction}

Doesn't require authentication via GET /api/v3/models/{model}/paths

Get latest Bailey announcement via GET /api/v3/news

Get Habitica's Server readiness status via GET /api/v3/ready

Get Habitica's API status via GET /api/v3/status

Get a user's tags via GET /api/v3/tags

Get a tag via GET /api/v3/tags/{tagId}

Get a task via GET /api/v3/tasks/{taskId}

Get a challenge's tasks via GET /api/v3/tasks/challenge/{challengeId}

Get a group's tasks via GET /api/v3/tasks/group/{groupId}

Get a user's tasks via GET /api/v3/tasks/user

The user profile contains data related to the authenticated user including (but not limited to): Achievements; Authentications (including types and timestamps); Challenges memberships (Challenge IDs); Flags (including armoire, tutorial, tour etc...); Guilds memberships (Guild IDs); History (including timestamps and values, only for Experience and summed To Do values); Inbox; Invitations (to parties/guilds); Items (character's full inventory); New Messages (flags for party/guilds that have new messages; also reported in Notifications); Notifications; Party (includes current quest information); Preferences (user selected prefs); Profile (name, photo url, blurb); Purchased (includes subscription data and some gem-purchased items); PushDevices (identifiers for mobile devices authorized); Stats (standard RPG stats, class, buffs, xp, etc..); Tags; TasksOrder (list of all IDs for Dailys, Habits, Rewards and To Do's). via GET /api/v3/user

Returns the user's data without: Authentication information, NewMessages/Invitations/Inbox, Profile, Purchased information, Contributor information, Special items, Webhooks, Notifications. via GET /api/v3/user/anonymized

Get the in app items appearing in the user's reward column via GET /api/v3/user/in-app-rewards

Get equipment/gear items available for purchase for the authenticated user via GET /api/v3/user/inventory/buy

Get webhooks via GET /api/v3/user/webhook

Does not require authentication. via GET /api/v3/world-state

Creates a challenge. Cannot create associated tasks with this route. See CreateChallengeTasks. via POST /api/v3/challenges

Clears flags on a challenge via POST /api/v3/challenges/{challengeId}/clearflags

Clone a challenge via POST /api/v3/challenges/{challengeId}/clone

Flag a challenge via POST /api/v3/challenges/{challengeId}/flag

Join a challenge via POST /api/v3/challenges/{challengeId}/join

Leave a challenge via POST /api/v3/challenges/{challengeId}/leave

Select winner for challenge via POST /api/v3/challenges/{challengeId}/selectWinner/{winnerId}

Redeem a coupon code via POST /api/v3/coupons/enter/{code}

Generate coupons for an event via POST /api/v3/coupons/generate/{event}

Validate a coupon code via POST /api/v3/coupons/validate/{code}

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. via POST /api/v3/cron

Moves a group task to a specified position via POST /api/v3/group/{groupId}/tasks/{taskId}/move/to/{position}

Create group via POST /api/v3/groups

Add a manager to a group via POST /api/v3/groups/{groupId}/add-manager

Posts a chat message to a group via POST /api/v3/groups/{groupId}/chat

Resets the flag count on a chat message. Retains the id of the user's that have flagged the message. (Only visible to moderators) via POST /api/v3/groups/{groupId}/chat/{chatId}/clearflags

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. via POST /api/v3/groups/{groupId}/chat/{chatId}/flag

Likes a chat message from a group via POST /api/v3/groups/{groupId}/chat/{chatId}/like

Mark all messages as read for a group via POST /api/v3/groups/{groupId}/chat/seen

You can provide both emails and uuids, or just one. You must provide at least one. via POST /api/v3/groups/{groupId}/invite

Join a group via POST /api/v3/groups/{groupId}/join

Leave a group via POST /api/v3/groups/{groupId}/leave

Abort the current quest via POST /api/v3/groups/{groupId}/quests/abort

Accept a pending quest via POST /api/v3/groups/{groupId}/quests/accept

Cancel a quest that is not active via POST /api/v3/groups/{groupId}/quests/cancel

Force-start a pending quest via POST /api/v3/groups/{groupId}/quests/force-start

Invite users to a quest via POST /api/v3/groups/{groupId}/quests/invite/{questKey}

Leave the active quest via POST /api/v3/groups/{groupId}/quests/leave

Reject a quest via POST /api/v3/groups/{groupId}/quests/reject

Reject a group invitation via POST /api/v3/groups/{groupId}/reject-invite

Remove a manager from a group via POST /api/v3/groups/{groupId}/remove-manager

Remove a member from a group via POST /api/v3/groups/{groupId}/removeMember/{memberId}

Create a Group and then redirect to the correct payment via POST /api/v3/groups/create-plan

Removes any abuse reports flagged on a user profile. via POST /api/v3/members/{memberId}/clear-flags

Sends an email to staff about another user or their profile via POST /api/v3/members/{memberId}/flag

Send a private message to a member via POST /api/v3/members/send-private-message

Send a gem gift to a member via POST /api/v3/members/transfer-gems

Add a notification to allow viewing of the latest "New Stuff by Bailey" message. Prevent this specific Bailey message from appearing automatically. via POST /api/v3/news/tell-me-later

Mark one notification as read via POST /api/v3/notifications/{notificationId}/read

Mark a notification as seen. Different from marking them as read in that the notification isn't removed but the seen field is set to true. via POST /api/v3/notifications/{notificationId}/see

Marks multiple notifications as read by removing them from the user's notification list. This differs from marking notifications as seen, which retains them but sets the seen field to true. via POST /api/v3/notifications/read

Mark multiple notifications as seen via POST /api/v3/notifications/see

Reorder a tag via POST /api/v3/reorder-tags

Create a new tag via POST /api/v3/tags

Assign users to a group task via POST /api/v3/tasks/{taskId}/assign

Add an item to the task's checklist via POST /api/v3/tasks/{taskId}/checklist

Score a checklist item via POST /api/v3/tasks/{taskId}/checklist/{itemId}/score

Note: completed To Do's are not sortable, do not appear in user.tasksOrder.todos, and are ordered by date of completion. via POST /api/v3/tasks/{taskId}/move/to/{position}

Mark an assigned group task as needing more work before it can be approved via POST /api/v3/tasks/{taskId}/needs-work/{userId}

Score a task via POST /api/v3/tasks/{taskId}/score/{direction}

Add a tag to a task via POST /api/v3/tasks/{taskId}/tags/{tagId}

Unassigns a user from a group task via POST /api/v3/tasks/{taskId}/unassign/{assignedUserId}

Can be passed an object to create a single task or an array of objects to create multiple tasks. via POST /api/v3/tasks/challenge/{challengeId}

Deletes all of a user's completed To Do's except those belonging to active Challenges and Group Plans. via POST /api/v3/tasks/clearCompletedTodos

Can be passed an object to create a single task or an array of objects to create multiple tasks. via POST /api/v3/tasks/group/{groupId}

Unlink all tasks from a challenge via POST /api/v3/tasks/unlink-all/{challengeId}

Unlink a challenge task via POST /api/v3/tasks/unlink-one/{taskId}

Can be passed an object to create a single task or an array of objects to create multiple tasks. via POST /api/v3/tasks/user

Allocates a single Stat Point. via POST /api/v3/user/allocate

Allocate multiple Stat Points via POST /api/v3/user/allocate-bulk

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. via POST /api/v3/user/allocate-now

Login a user with email / username and password via POST /api/v3/user/auth/local/login

Register a new user with email, login name, and password or attach local authentication to a social auth user via POST /api/v3/user/auth/local/register

Set a new password for a user that reset theirs. Not meant for public usage. via POST /api/v3/user/auth/reset-password-set-new-one

Block / unblock a user from sending you a PM via POST /api/v3/user/block/{uuid}

Buy an Enchanted Armoire item via POST /api/v3/user/buy-armoire

Under the hood uses UserBuyGear, UserBuyPotion and UserBuyArmoire via POST /api/v3/user/buy/{key}

Buy a piece of gear via POST /api/v3/user/buy-gear/{key}

Buy a health potion via POST /api/v3/user/buy-health-potion

This buys a Mystery Item set using an Hourglass. via POST /api/v3/user/buy-mystery-set/{key}

Buy a quest with gold via POST /api/v3/user/buy-quest/{key}

Includes gift cards (e.g., birthday card), and avatar Transformation Items and their antidotes (e.g., Snowball item and Salt reward). via POST /api/v3/user/buy-special-spell/{key}

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). via POST /api/v3/user/change-class

Skill Key to Name Mapping 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" via POST /api/v3/user/class/cast/{spellId}

Set Custom Day Start time for user. via POST /api/v3/user/custom-day-start

Disable classes via POST /api/v3/user/disable-classes

Equip or unequip an item via POST /api/v3/user/equip/{type}/{key}

Feed a pet via POST /api/v3/user/feed/{pet}/{food}

Hatch a pet via POST /api/v3/user/hatch/{egg}/{hatchingPotion}

Mark Private Messages as read via POST /api/v3/user/mark-pms-read

Move a pinned item in the rewards column to a new position after being sorted via POST /api/v3/user/move-pinned-item/{type}/{path}/move/to/{position}

Open the Mystery Item box via POST /api/v3/user/open-mystery-item

Purchase Gem or Gem-purchasable item via POST /api/v3/user/purchase/{type}/{key}

Purchases an Hourglass-purchasable item. Does not include Mystery Item sets (use /api/v3/user/buy-mystery-set/:key). via POST /api/v3/user/purchase-hourglass/{type}/{key}

Read a card via POST /api/v3/user/read-card/{cardType}

Use Orb of Rebirth on user via POST /api/v3/user/rebirth

Release pets and mounts and grants Triad Bingo via POST /api/v3/user/release-both

Release mounts via POST /api/v3/user/release-mounts

Reroll a user (reset tasks) using the Fortify Potion via POST /api/v3/user/reroll

Reset user via POST /api/v3/user/reset

Send the user an email to let them reset their password via POST /api/v3/user/reset-password

Revive user from death via POST /api/v3/user/revive

Sell a gold-sellable item owned by the user via POST /api/v3/user/sell/{type}/{key}

Toggles the sleep key under user preference true and false. via POST /api/v3/user/sleep

Request a refresh of user stats, including processing of pending level-ups via POST /api/v3/user/stat-sync

Unlock item or set of items by purchase via POST /api/v3/user/unlock

Create a new webhook - BETA via POST /api/v3/user/webhook

Update a challenge's name, description, or summary via PUT /api/v3/challenges/{challengeId}

Update group via PUT /api/v3/groups/{groupId}

Update various details in the user's User document, including but not limited to privileges, gems, contributions, items. via PUT /api/v3/hall/heroes/{heroId}

Update a tag via PUT /api/v3/tags/{tagId}

Update a task via PUT /api/v3/tasks/{taskId}

Update a checklist item via PUT /api/v3/tasks/{taskId}/checklist/{itemId}

Some of the user items can be updated, such as preferences, flags and stats. ^ via PUT /api/v3/user

Change the user email address via PUT /api/v3/user/auth/update-email

Update the password of a local user via PUT /api/v3/user/auth/update-password

Update and verify the user's username via PUT /api/v3/user/auth/update-username

Can change url, enabled, type, and options properties. Cannot change id. via PUT /api/v3/user/webhook/{id}