API Options

The API page can be accessed from the Settings menu (direct link). It presents user credentials (the User ID and the API Token) and displays a QR code which can quickly load the user credentials into some applications.

User ID (UID) Edit

The User ID or Unique User ID (UID) is a complex hexadecimal number that Habitica automatically generates when a player joins, similar to a username.

You'll need it to:

• Join a party or private guild
• Request administrative help with your account
• Receive Contributor Rewards if you contribute to Habitica
• Submit a bug
• Connect with 3rd party apps.

To find your User ID, go to Settings → API (direct link).

To find someone else's User ID, click on that person's name in Tavern Chat or any other Habitica chat room. It will be displayed on their profile. If you are already in a party with them, you can view their profile by clicking their name in the Members box on your party page.

API Token Edit

The API token is a unique security code generated along with your User ID. It is similar to a password so it is essential that you keep this token private and never share this token with any untrustworthy applications or people!

To find your API Token, go to Settings → API (direct link).

QR Code Edit

The QR code is currently used by the iOS app and the Android app to invite party members and send private messages. The QR code does not contain your API Token. Instead it contains the following URL: https://habitica.com/qr-code/user/[User ID]. For example the QR Code for WikiFAQ bot (User ID: 29bfa638-cb88-40e8-a0d0-48f455e7b2bd) is: https://habitica.com/qr-code/user/29bfa638-cb88-40e8-a0d0-48f455e7b2bd.