Habitica icon

Habitica

Habitica API

Overview

This node integrates with the Habitica API to retrieve user profile information. It is designed to fetch either a subset of user data based on selected categories or all available user information. This functionality is useful for scenarios where you want to display or process specific parts of a user's Habitica profile, such as their achievements, party details, or inbox status.

Practical examples include:

  • Fetching only the "Achievements" and "Stats" categories to display a user's progress.
  • Retrieving the entire user profile for backup or synchronization purposes.
  • Filtering user data to show only relevant sections in a dashboard or report.

Properties

Name Meaning
Get All Info Boolean flag indicating whether to retrieve all available user information (true) or only selected categories (false).
Select Categories Multi-select list allowing the user to specify which categories of user data to retrieve when "Get All Info" is false. Options include: Items, Stats, Party, Inbox, Profile, Achievements, Backer, Contributor, Login Incentives.

Output

The node outputs JSON data representing the user's profile information from Habitica. The structure depends on the input properties:

  • If Get All Info is true, the output contains the full user profile data as returned by the Habitica API.
  • If Get All Info is false, the output includes only the selected categories specified in Select Categories, joined as a comma-separated query parameter to filter the response accordingly.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential for authenticating with the Habitica API.
  • The base URL for API requests can be configured to use either the official Habitica API endpoint or a self-hosted instance, depending on credential settings.
  • No additional external services are required beyond the Habitica API.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Selecting no categories while "Get All Info" is false may result in incomplete or empty responses.
    • Network connectivity problems or incorrect base URL configuration can prevent successful API calls.
  • Error messages:

    • Authentication errors typically indicate invalid API keys; verify and update credentials.
    • HTTP errors from the API (e.g., 404, 500) suggest issues with the request or server; check parameters and API status.
    • Empty or malformed responses may occur if category names are misspelled or unsupported; ensure correct category selection.

Links and References

Discussion