Skip to main content
Server path: /habitica-user | Type: Application | PCID required: Yes

Tools

ToolDescription
habitica_user_create_cronRun cron
habitica_user_create_notifications_by_notification_id_readMark Notification as Read
habitica_user_create_notifications_by_notification_id_seeMark Notification as Seen
habitica_user_create_notifications_readMark Notifications as Read
habitica_user_create_notifications_seeMark Notifications as Seen
habitica_user_create_user_allocateAllocate a single Stat Point
habitica_user_create_user_allocate_bulkAllocate multiple Stat Points
habitica_user_create_user_allocate_nowAllocate all Stat Points
habitica_user_create_user_block_by_uuidBlock / unblock a user from sending you a PM
habitica_user_create_user_buy_armoireBuy Enchanted Armoire
habitica_user_create_user_buy_by_keyBuy gear, armoire or potion
habitica_user_create_user_buy_gear_by_keyBuy a piece of gear
habitica_user_create_user_buy_health_potionBuy a health potion
habitica_user_create_user_buy_mystery_set_by_keyBuy a Mystery Item set
habitica_user_create_user_buy_quest_by_keyBuy a quest with gold
habitica_user_create_user_buy_special_spell_by_keyBuy special item (card, avatar transformation)
habitica_user_create_user_change_classChange the class of the authenticated user
habitica_user_create_user_class_cast_by_spell_idCast a skill (spell) on yourself or a target
habitica_user_create_user_custom_day_startSet Custom Day Start time for user
habitica_user_create_user_disable_classesDisable Classes
habitica_user_create_user_mark_pms_readMark Private Messages as read
habitica_user_create_user_open_mystery_itemOpen the Mystery Item box
habitica_user_create_user_purchase_by_type_by_keyPurchase Gem or Gem-purchasable item
habitica_user_create_user_purchase_hourglass_by_type_by_keyPurchase Hourglass-purchasable item
habitica_user_create_user_read_card_by_card_typeRead a card
habitica_user_create_user_rebirthUse Orb of Rebirth on user
habitica_user_create_user_rerollReroll user stats
habitica_user_create_user_resetReset user
habitica_user_create_user_reviveRevive user from death
habitica_user_create_user_sell_by_type_by_keySell a gold-sellable item owned by the user
habitica_user_create_user_sleepMake the user start / stop sleeping (resting in the Inn)
habitica_user_create_user_unequip_by_typeUnequip all items by type
habitica_user_create_user_unlockUnlock item or set of items by purchase
habitica_user_create_user_webhookCreate user webhook
habitica_user_delete_messagesDelete all messages
habitica_user_delete_messages_by_idDelete User Message
habitica_user_delete_userDelete User Account [Danger]
habitica_user_delete_webhook_by_idDelete a webhook
habitica_user_get_anonymizedGet anonymized user data
habitica_user_get_inbox_messagesGet Inbox Messages
habitica_user_get_purchase_historyGet user purchase history
habitica_user_get_userGet user information
habitica_user_get_webhookGet user webhooks
habitica_user_update_userUpdate the user
habitica_user_update_user_auth_update_emailUpdate email
habitica_user_update_user_auth_update_passwordUpdate password
habitica_user_update_user_auth_update_usernameUpdate User’s Username
habitica_user_update_user_webhook_by_idEdit a webhook

habitica_user_create_cron

Run cron

habitica_user_create_notifications_by_notification_id_read

Mark Notification as Read Parameters:
ParameterTypeRequiredDefaultDescription
notificationIdstringYesThe ID of the notification to mark as read.

habitica_user_create_notifications_by_notification_id_see

Mark Notification as Seen Parameters:
ParameterTypeRequiredDefaultDescription
notificationIdstringYesThe ID of the notification to mark as seen.

habitica_user_create_notifications_read

Mark Notifications as Read

habitica_user_create_notifications_see

Mark Notifications as Seen

habitica_user_create_user_allocate

Allocate a single Stat Point Parameters:
ParameterTypeRequiredDefaultDescription
statstringYesThe stat to increase (str, con, int, or per)

habitica_user_create_user_allocate_bulk

Allocate multiple Stat Points Parameters:
ParameterTypeRequiredDefaultDescription
statsobjectNoThe stats value

habitica_user_create_user_allocate_now

Allocate all Stat Points

habitica_user_create_user_block_by_uuid

Block / unblock a user from sending you a PM Parameters:
ParameterTypeRequiredDefaultDescription
uuidstringYesThe UUID of the user to block.

habitica_user_create_user_buy_armoire

Buy Enchanted Armoire

habitica_user_create_user_buy_by_key

Buy gear, armoire or potion Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe item to buy

habitica_user_create_user_buy_gear_by_key

Buy a piece of gear Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key of the gear to be purchased.

habitica_user_create_user_buy_health_potion

Buy a health potion

habitica_user_create_user_buy_mystery_set_by_key

Buy a Mystery Item set Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key of the mystery set to be purchased.

habitica_user_create_user_buy_quest_by_key

Buy a quest with gold Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key of the quest to be purchased.

habitica_user_create_user_buy_special_spell_by_key

Buy special item (card, avatar transformation) Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe special item to buy. Must be one of the keys from “content.special”, such as birthday, snowball, salt.

habitica_user_create_user_change_class

Change the class of the authenticated user Parameters:
ParameterTypeRequiredDefaultDescription
classstringYesThe new class to change to

habitica_user_create_user_class_cast_by_spell_id

Cast a skill (spell) on yourself or a target Parameters:
ParameterTypeRequiredDefaultDescription
spellIdstringYesID of the spell to cast
targetIdstringNoUser ID of the target (optional)

habitica_user_create_user_custom_day_start

Set Custom Day Start time for user Parameters:
ParameterTypeRequiredDefaultDescription
dayStartnumberNoThe hour number (0-23) for the day to begin. If not supplied, it will default to 0.

habitica_user_create_user_disable_classes

Disable Classes

habitica_user_create_user_mark_pms_read

Mark Private Messages as read

habitica_user_create_user_open_mystery_item

Open the Mystery Item box

habitica_user_create_user_purchase_by_type_by_key

Purchase Gem or Gem-purchasable item Parameters:
ParameterTypeRequiredDefaultDescription
typestringYesType of item to purchase. Can be gems, eggs, hatchingPotions, premiumHatchingPotions, food, quests, gear, or pets.
keystringYesItem’s key (use “gem” for purchasing gems).
quantityintegerNoCount of items to buy. Defaults to 1 and is ignored for items where quantity is irrelevant.

habitica_user_create_user_purchase_hourglass_by_type_by_key

Purchase Hourglass-purchasable item Parameters:
ParameterTypeRequiredDefaultDescription
typestringYesThe type of item to purchase.
keystringYesThe key for the mount/pet.
quantityintegerNoCount of items to buy. Defaults to 1 and is ignored for items where quantity is irrelevant.

habitica_user_create_user_read_card_by_card_type

Read a card Parameters:
ParameterTypeRequiredDefaultDescription
cardTypestringYesThe of card to read (e.g. birthday, greeting, nye, thankyou, valentine).

habitica_user_create_user_rebirth

Use Orb of Rebirth on user

habitica_user_create_user_reroll

Reroll user stats

habitica_user_create_user_reset

Reset user

habitica_user_create_user_revive

Revive user from death

habitica_user_create_user_sell_by_type_by_key

Sell a gold-sellable item owned by the user Parameters:
ParameterTypeRequiredDefaultDescription
typestringYesThe type of item to sell
keystringYesThe key of the item
amountnumberNoThe amount to sell

habitica_user_create_user_sleep

Make the user start / stop sleeping (resting in the Inn)

habitica_user_create_user_unequip_by_type

Unequip all items by type Parameters:
ParameterTypeRequiredDefaultDescription
typestringYesType of the item to be unequipped

habitica_user_create_user_unlock

Unlock item or set of items by purchase Parameters:
ParameterTypeRequiredDefaultDescription
pathstringYesFull path to unlock. See “content” API call for list of items

habitica_user_create_user_webhook

Create user webhook Parameters:
ParameterTypeRequiredDefaultDescription
enabledbooleanNoIf the webhook should be enabled.
idstringNoThe webhook’s id.
labelstringNoA label to remind you what this webhook does.
optionsobjectNoThe 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.
typestringNoThe webhook’s type.
urlstringYesThe webhook’s URL.

habitica_user_delete_messages

Delete all messages

habitica_user_delete_messages_by_id

Delete User Message Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesID of the message to delete

habitica_user_delete_user

Delete User Account [Danger] Parameters:
ParameterTypeRequiredDefaultDescription
feedbackstringNoThe feedback value
passwordstringNoThe password value

habitica_user_delete_webhook_by_id

Delete a webhook Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesId (UUID) of the webhook to retrieve

habitica_user_get_anonymized

Get anonymized user data

habitica_user_get_inbox_messages

Get Inbox Messages Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoLoad the messages of the selected Page - 10 Messages per Page
conversationstringNoLoads only the messages of a conversation

habitica_user_get_purchase_history

Get user purchase history

habitica_user_get_user

Get user information

habitica_user_get_webhook

Get user webhooks

habitica_user_update_user

Update the user Parameters:
ParameterTypeRequiredDefaultDescription
achievementsobjectNoThe achievements value
flagsobjectNoThe flags value
preferencesobjectNoThe preferences value
profileobjectNoThe profile value
statsobjectNoThe stats value

habitica_user_update_user_auth_update_email

Update email Parameters:
ParameterTypeRequiredDefaultDescription
newEmailstringYesThe new email address
passwordstringNoThe user password

habitica_user_update_user_auth_update_password

Update password Parameters:
ParameterTypeRequiredDefaultDescription
confirmPasswordstringNoNew password confirmation
newPasswordstringNoThe new password
passwordstringNoThe old password

habitica_user_update_user_auth_update_username

Update User’s Username Parameters:
ParameterTypeRequiredDefaultDescription
passwordstringNoThe user’s password if they use local authentication. Omit if they use social auth.
usernamestringYesThe new username

habitica_user_update_user_webhook_by_id

Edit a webhook Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesId (UUID) of the webhook to retrieve
enabledbooleanNoIf the webhook should be enabled.
labelstringNoA label to remind you what this webhook does.
optionsobjectNoThe webhook’s options. Will differ depending on type. The options are enumerated in the add webhook examples.
typestringNoThe webhook’s type.
urlstringNoThe webhook’s URL.