API Options Navigation

The API page can be accessed from the Settings option from the User Icon menu. 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:

To find your User ID:

  • For the website: User Icon → Settings → API
  • For iOS/Android App: Settings → Account Details → User Id (tap on it to copy it to clipboard).

You can also find the User ID of other players in their profile.

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! If you have accidentally shared your API token in a public space or with untrusted source you can ask in the Report a Bug Guild or email to change your API token.

To find your API Token,

  • For the website: User Icon → Settings → API
  • For iOS/Android App: Settings → API → API Key (tap on it and select copy to copy it to clipboard).

QR Code Edit

WikiFAQ Bot QR Code

QR Code for WikiFAQ Bot

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:[User ID]. For example, the QR Code for WikiFAQ bot (User ID: 29bfa638-cb88-40e8-a0d0-48f455e7b2bd) is: