← Tools Reference

Habitica

Habitica integration (Productivity). Imported from open-connector.

API key11 toolshttps://habitica.com/api/v3
GET
habitica_get_user_profile
Get the authenticated Habitica user's profile with optional userFields filtering.

/user

1 parameter
ParamTypeRequiredDescription
userFieldsstringoptionalA comma-separated Habitica userFields selection passed through to the /user end…
GET
habitica_list_my_tasks
List the authenticated Habitica user's tasks with optional type and dueDate filters.

/tasks/user

2 parameters
ParamTypeRequiredDescription
typestringoptionalThe task type filter supported by Habitica.
dueDatestringoptionalThe optional date used for Habitica nextDue computation.
GET
habitica_get_task
Get one Habitica task by task ID or alias.

/tasks/{taskId}

1 parameter
ParamTypeRequiredDescription
taskIdstringrequiredThe Habitica task ID or alias.
POST
habitica_create_task
Create one new personal Habitica task from a single JSON task object.

/tasks/user

21 parameters
ParamTypeRequiredDescription
textstringrequiredThe text displayed for the Habitica task.
typestringrequiredThe Habitica task type.
tagsarrayoptionalThe Habitica tag IDs to attach to the task.
aliasstringoptionalAn optional Habitica alias for the task.
attributestringoptionalThe Habitica stat associated with the task.
checklistarrayoptionalThe checklist items to attach to the task.
collapseChecklistbooleanoptionalWhether Habitica should collapse the checklist.
notesstringoptionalAdditional Habitica task notes.
datestringoptionalThe due date to send to Habitica for todo tasks.
prioritynumberoptionalThe Habitica task priority.
frequencystringoptionalThe Habitica daily frequency.
repeatobjectoptionalThe Habitica repeat object for dailies, keyed by weekday abbreviations.
everyXintegeroptionalThe Habitica everyX interval for dailies.
streakintegeroptionalThe Habitica streak value for dailies.
daysOfMontharrayoptionalThe Habitica daysOfMonth values for monthly dailies.
weeksOfMontharrayoptionalThe Habitica weeksOfMonth values for monthly dailies.
startDatestringoptionalThe Habitica start date for dailies.
upbooleanoptionalWhether a habit can be scored up.
downbooleanoptionalWhether a habit can be scored down.
valuenumberoptionalThe Habitica reward cost or task value.
completedbooleanoptionalWhether the task is completed.
PUT
habitica_update_task
Update one Habitica task by task ID or alias.

/tasks/{taskId}

21 parameters
ParamTypeRequiredDescription
taskIdstringrequiredThe Habitica task ID or alias.
textstringoptionalThe text displayed for the Habitica task.
tagsarrayoptionalThe Habitica tag IDs to attach to the task.
aliasstringoptionalAn optional Habitica alias for the task.
attributestringoptionalThe Habitica stat associated with the task.
checklistarrayoptionalThe checklist items to attach to the task.
collapseChecklistbooleanoptionalWhether Habitica should collapse the checklist.
notesstringoptionalAdditional Habitica task notes.
datestringoptionalThe due date to send to Habitica for todo tasks.
prioritynumberoptionalThe Habitica task priority.
frequencystringoptionalThe Habitica daily frequency.
repeatobjectoptionalThe Habitica repeat object for dailies, keyed by weekday abbreviations.
everyXintegeroptionalThe Habitica everyX interval for dailies.
streakintegeroptionalThe Habitica streak value for dailies.
daysOfMontharrayoptionalThe Habitica daysOfMonth values for monthly dailies.
weeksOfMontharrayoptionalThe Habitica weeksOfMonth values for monthly dailies.
startDatestringoptionalThe Habitica start date for dailies.
upbooleanoptionalWhether a habit can be scored up.
downbooleanoptionalWhether a habit can be scored down.
valuenumberoptionalThe Habitica reward cost or task value.
completedbooleanoptionalWhether the task is completed.
DELETE
habitica_delete_task
Delete one Habitica task by task ID or alias.

/tasks/{taskId}

1 parameter
ParamTypeRequiredDescription
taskIdstringrequiredThe Habitica task ID or alias.
POST
habitica_score_task
Score one Habitica task in the up or down direction.

/tasks/{taskId}/score/{direction}

2 parameters
ParamTypeRequiredDescription
taskIdstringrequiredThe Habitica task ID or alias.
directionstringrequiredThe direction used to score a Habitica task.
GET
habitica_list_tags
List the authenticated Habitica user's tags.

/tags

POST
habitica_create_tag
Create one new Habitica tag.

/tags

1 parameter
ParamTypeRequiredDescription
namestringrequiredThe Habitica tag name.
PUT
habitica_update_tag
Update one Habitica tag by tag ID.

/tags/{tagId}

2 parameters
ParamTypeRequiredDescription
tagIdstringrequiredThe Habitica tag ID.
namestringrequiredThe replacement Habitica tag name.
DELETE
habitica_delete_tag
Delete one Habitica tag by tag ID.

/tags/{tagId}

1 parameter
ParamTypeRequiredDescription
tagIdstringrequiredThe Habitica tag ID.