/habitica-tasks | Type: Application | PCID required: Yes
Tools
habitica_tasks_create_group_by_group_id_tasks_by_task_id_move_to_by_position
Move a group task to a specified position Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted) |
taskId | string | Yes | — | The task _id or alias |
position | integer | Yes | — | Where to move the task. 0 = top of the list (“push to top”). -1 = bottom of the list (“push to bottom”) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "The group id ('party' for the user party and 'habitrpg' for tavern are accepted)"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
},
"position": {
"type": "integer",
"description": "Where to move the task. 0 = top of the list (\"push to top\"). -1 = bottom of the list (\"push to bottom\")"
}
},
"required": [
"PCID",
"groupId",
"taskId",
"position"
]
}
habitica_tasks_create_reorder_tags
Reorder Tags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tagId | string | No | — | The ID of the tag to reorder. |
to | number | No | — | The new position of the tag in the order. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tagId": {
"type": "string",
"description": "The ID of the tag to reorder."
},
"to": {
"type": "number",
"description": "The new position of the tag in the order."
}
},
"required": [
"PCID"
]
}
habitica_tasks_create_tags
Create a new tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | The name of the new tag. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "The name of the new tag."
}
},
"required": [
"PCID"
]
}
habitica_tasks_create_tasks_by_task_id_assign
Assign a group task to a user or users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The id of the task that will be assigned |
body | string[] | No | — | The ID of the user to whom the task will be assigned |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The id of the task that will be assigned"
},
"body": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
},
"description": "The ID of the user to whom the task will be assigned"
}
},
"required": [
"PCID",
"taskId"
]
}
habitica_tasks_create_tasks_by_task_id_checklist
Add an item to the task’s checklist Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The task _id or alias |
completed | boolean | No | — | Whether the checklist item is checked off |
text | string | Yes | — | The text of the checklist item |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
},
"completed": {
"type": "boolean",
"description": "Whether the checklist item is checked off"
},
"text": {
"type": "string",
"description": "The text of the checklist item"
}
},
"required": [
"PCID",
"taskId",
"text"
]
}
habitica_tasks_create_tasks_by_task_id_checklist_by_item_id_score
Score a checklist item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The task _id or alias |
itemId | string | Yes | — | The checklist item _id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
},
"itemId": {
"type": "string",
"description": "The checklist item _id"
}
},
"required": [
"PCID",
"taskId",
"itemId"
]
}
habitica_tasks_create_tasks_by_task_id_move_to_by_position
Move a task to a new position Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The task _id or alias |
position | integer | Yes | — | Where to move the task. 0 = top of the list (“push to top”). -1 = bottom of the list (“push to bottom”) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
},
"position": {
"type": "integer",
"description": "Where to move the task. 0 = top of the list (\"push to top\"). -1 = bottom of the list (\"push to bottom\")"
}
},
"required": [
"PCID",
"taskId",
"position"
]
}
habitica_tasks_create_tasks_by_task_id_needs_work_by_user_id
Require more work for a group task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The id pr alies of the task that is the original group task |
userId | string | Yes | — | The id of the assigned user |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The id pr alies of the task that is the original group task"
},
"userId": {
"type": "string",
"description": "The id of the assigned user"
}
},
"required": [
"PCID",
"taskId",
"userId"
]
}
habitica_tasks_create_tasks_by_task_id_score_by_direction
Score a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The task _id or alias |
direction | string | Yes | — | The direction for scoring the task (up or down). |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
},
"direction": {
"type": "string",
"description": "The direction for scoring the task (up or down).",
"enum": [
"up",
"down"
]
}
},
"required": [
"PCID",
"taskId",
"direction"
]
}
habitica_tasks_create_tasks_by_task_id_tags_by_tag_id
Add a tag to a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The task _id or alias |
tagId | string | Yes | — | The tag id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
},
"tagId": {
"type": "string",
"description": "The tag id"
}
},
"required": [
"PCID",
"taskId",
"tagId"
]
}
habitica_tasks_create_tasks_by_task_id_unassign_by_assigned_user_id
Unassign a user from a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The id of the task that is the original group task |
assignedUserId | string | Yes | — | The id of the user that will be unassigned from the task |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The id of the task that is the original group task"
},
"assignedUserId": {
"type": "string",
"description": "The id of the user that will be unassigned from the task"
}
},
"required": [
"PCID",
"taskId",
"assignedUserId"
]
}
habitica_tasks_create_tasks_challenge_by_challenge_id
Create a new task belonging to a challenge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | The id of the challenge |
attribute | string | No | — | User’s attribute to use, options are: str, int, per, con |
collapseChecklist | boolean | No | — | Determines if a checklist will be displayed |
date | string | No | — | Due date to be shown in task list. Only valid for type “todo” |
daysOfMonth | integer[] | No | — | Array of integers. Only valid for type “daily” |
down | boolean | No | — | Only valid for type “habit” If true, enables the ”-” under “Directions/Action” for “Bad habits” |
everyX | integer | No | — | Value of frequency must be “daily”, the number of days until this daily task is available again |
frequency | string | No | — | Values “weekly” and “monthly” enable use of the “repeat” field. All frequency values enable use of the “everyX” field. Value “monthly” enables use of the “weeksOfMonth” and “daysOfMonth” fields. Frequency is only valid for type “daily”. |
notes | string | No | — | Extra notes |
priority | number | No | — | Difficulty, options are 0.1, 1, 1.5, 2; equivalent of Trivial, Easy, Medium, Hard |
reminders | string[] | No | — | Array of reminders, each an object that must include: a UUID, startDate and time.\nFor example: {“id”:“ed427623-9a69-4aac-9852-13deb9c190c3”, “startDate”:“1/16/17”,“time”:“1/16/17” } |
repeat | object | No | — | Days of the week to repeat. Keys: su, m, t, w, th, f, s. Values: true/false. Only valid for type “daily” with frequency “weekly”. |
startDate | string | No | — | Date when the task will first become available. Only valid for type “daily” |
streak | integer | No | — | Number of days that the task has consecutively been checked off. Only valid for type “daily” |
text | string | Yes | — | The text to be displayed for the task |
type | string | Yes | — | Task type, options are: habit, daily, todo, reward |
up | boolean | No | — | Only valid for type “habit” If true, enables the ”+” under “Directions/Action” for “Good habits” |
value | integer | No | — | Only valid for type “reward.” The cost in gold of the reward |
weeksOfMonth | integer[] | No | — | Array of integers. Only valid for type “daily” |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"challengeId": {
"type": "string",
"description": "The id of the challenge"
},
"attribute": {
"type": "string",
"description": "User's attribute to use, options are: `str`, `int`, `per`, `con`",
"enum": [
"str",
"int",
"per",
"con"
]
},
"collapseChecklist": {
"type": "boolean",
"description": "Determines if a checklist will be displayed"
},
"date": {
"type": "string",
"description": "Due date to be shown in task list. Only valid for type \"todo\""
},
"daysOfMonth": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of integers. Only valid for type \"daily\""
},
"down": {
"type": "boolean",
"description": "Only valid for type \"habit\" If true, enables the \"-\" under \"Directions/Action\" for \"Bad habits\""
},
"everyX": {
"type": "integer",
"description": "Value of frequency must be \"daily\", the number of days until this daily task is available again"
},
"frequency": {
"type": "string",
"description": "Values \"weekly\" and \"monthly\" enable use of the \"repeat\" field. All frequency values enable use of the \"everyX\" field. Value \"monthly\" enables use of the \"weeksOfMonth\" and \"daysOfMonth\" fields. Frequency is only valid for type \"daily\".",
"enum": [
"daily",
"weekly",
"monthly",
"yearly"
]
},
"notes": {
"type": "string",
"description": "Extra notes"
},
"priority": {
"type": "number",
"description": "Difficulty, options are 0.1, 1, 1.5, 2; equivalent of Trivial, Easy, Medium, Hard",
"enum": [
0.1,
1,
1.5,
2
]
},
"reminders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of reminders, each an object that must include: a UUID, startDate and time.\\nFor example: {\"id\":\"ed427623-9a69-4aac-9852-13deb9c190c3\", \"startDate\":\"1/16/17\",\"time\":\"1/16/17\" }"
},
"repeat": {
"type": "object",
"description": "Days of the week to repeat. Keys: su, m, t, w, th, f, s. Values: true/false. Only valid for type \"daily\" with frequency \"weekly\".",
"properties": {
"su": {
"type": "boolean",
"description": "The su value"
},
"m": {
"type": "boolean",
"description": "The m value"
},
"t": {
"type": "boolean",
"description": "The t value"
},
"w": {
"type": "boolean",
"description": "The w value"
},
"th": {
"type": "boolean",
"description": "The th value"
},
"f": {
"type": "boolean",
"description": "The f value"
},
"s": {
"type": "boolean",
"description": "The s value"
}
}
},
"startDate": {
"type": "string",
"description": "Date when the task will first become available. Only valid for type \"daily\""
},
"streak": {
"type": "integer",
"description": "Number of days that the task has consecutively been checked off. Only valid for type \"daily\""
},
"text": {
"type": "string",
"description": "The text to be displayed for the task"
},
"type": {
"type": "string",
"description": "Task type, options are: `habit`, `daily`, `todo`, `reward`",
"enum": [
"habit",
"daily",
"todo",
"reward"
]
},
"up": {
"type": "boolean",
"description": "Only valid for type \"habit\" If true, enables the \"+\" under \"Directions/Action\" for \"Good habits\""
},
"value": {
"type": "integer",
"description": "Only valid for type \"reward.\" The cost in gold of the reward"
},
"weeksOfMonth": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of integers. Only valid for type \"daily\""
}
},
"required": [
"PCID",
"challengeId",
"text",
"type"
]
}
habitica_tasks_create_tasks_clear_completed_todos
Delete user’s completed todosShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
habitica_tasks_create_tasks_group_by_group_id
Create a new task belonging to a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted) |
attribute | string | No | — | User’s attribute to use, options are: str, int, per, con |
collapseChecklist | boolean | No | — | Determines if a checklist will be displayed |
date | string | No | — | Due date to be shown in task list. Only valid for type “todo” |
daysOfMonth | integer[] | No | — | Array of integers. Only valid for type “daily” |
down | boolean | No | — | Only valid for type “habit” If true, enables the ”-” under “Directions/Action” for “Bad habits” |
everyX | integer | No | — | Value of frequency must be “daily”, the number of days until this daily task is available again |
frequency | string | No | — | Values “weekly” and “monthly” enable use of the “repeat” field. All frequency values enable use of the “everyX” field. Value “monthly” enables use of the “weeksOfMonth” and “daysOfMonth” fields. Frequency is only valid for type “daily”. |
notes | string | No | — | Extra notes |
priority | number | No | — | Difficulty, options are 0.1, 1, 1.5, 2; equivalent of Trivial, Easy, Medium, Hard |
reminders | string[] | No | — | Array of reminders, each an object that must include: a UUID, startDate and time.\nFor example: {“id”:“ed427623-9a69-4aac-9852-13deb9c190c3”, “startDate”:“1/16/17”,“time”:“1/16/17” } |
repeat | object | No | — | Days of the week to repeat. Keys: su, m, t, w, th, f, s. Values: true/false. Only valid for type “daily” with frequency “weekly”. |
startDate | string | No | — | Date when the task will first become available. Only valid for type “daily” |
streak | integer | No | — | Number of days that the task has consecutively been checked off. Only valid for type “daily” |
text | string | Yes | — | The text to be displayed for the task |
type | string | Yes | — | Task type, options are: habit, daily, todo, reward |
up | boolean | No | — | Only valid for type “habit” If true, enables the ”+” under “Directions/Action” for “Good habits” |
value | integer | No | — | Only valid for type “reward.” The cost in gold of the reward |
weeksOfMonth | integer[] | No | — | Array of integers. Only valid for type “daily” |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "The group id ('party' for the user party and 'habitrpg' for tavern are accepted)"
},
"attribute": {
"type": "string",
"description": "User's attribute to use, options are: `str`, `int`, `per`, `con`",
"enum": [
"str",
"int",
"per",
"con"
]
},
"collapseChecklist": {
"type": "boolean",
"description": "Determines if a checklist will be displayed"
},
"date": {
"type": "string",
"description": "Due date to be shown in task list. Only valid for type \"todo\""
},
"daysOfMonth": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of integers. Only valid for type \"daily\""
},
"down": {
"type": "boolean",
"description": "Only valid for type \"habit\" If true, enables the \"-\" under \"Directions/Action\" for \"Bad habits\""
},
"everyX": {
"type": "integer",
"description": "Value of frequency must be \"daily\", the number of days until this daily task is available again"
},
"frequency": {
"type": "string",
"description": "Values \"weekly\" and \"monthly\" enable use of the \"repeat\" field. All frequency values enable use of the \"everyX\" field. Value \"monthly\" enables use of the \"weeksOfMonth\" and \"daysOfMonth\" fields. Frequency is only valid for type \"daily\".",
"enum": [
"daily",
"weekly",
"monthly",
"yearly"
]
},
"notes": {
"type": "string",
"description": "Extra notes"
},
"priority": {
"type": "number",
"description": "Difficulty, options are 0.1, 1, 1.5, 2; equivalent of Trivial, Easy, Medium, Hard",
"enum": [
0.1,
1,
1.5,
2
]
},
"reminders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of reminders, each an object that must include: a UUID, startDate and time.\\nFor example: {\"id\":\"ed427623-9a69-4aac-9852-13deb9c190c3\", \"startDate\":\"1/16/17\",\"time\":\"1/16/17\" }"
},
"repeat": {
"type": "object",
"description": "Days of the week to repeat. Keys: su, m, t, w, th, f, s. Values: true/false. Only valid for type \"daily\" with frequency \"weekly\".",
"properties": {
"su": {
"type": "boolean",
"description": "The su value"
},
"m": {
"type": "boolean",
"description": "The m value"
},
"t": {
"type": "boolean",
"description": "The t value"
},
"w": {
"type": "boolean",
"description": "The w value"
},
"th": {
"type": "boolean",
"description": "The th value"
},
"f": {
"type": "boolean",
"description": "The f value"
},
"s": {
"type": "boolean",
"description": "The s value"
}
}
},
"startDate": {
"type": "string",
"description": "Date when the task will first become available. Only valid for type \"daily\""
},
"streak": {
"type": "integer",
"description": "Number of days that the task has consecutively been checked off. Only valid for type \"daily\""
},
"text": {
"type": "string",
"description": "The text to be displayed for the task"
},
"type": {
"type": "string",
"description": "Task type, options are: `habit`, `daily`, `todo`, `reward`",
"enum": [
"habit",
"daily",
"todo",
"reward"
]
},
"up": {
"type": "boolean",
"description": "Only valid for type \"habit\" If true, enables the \"+\" under \"Directions/Action\" for \"Good habits\""
},
"value": {
"type": "integer",
"description": "Only valid for type \"reward.\" The cost in gold of the reward"
},
"weeksOfMonth": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of integers. Only valid for type \"daily\""
}
},
"required": [
"PCID",
"groupId",
"text",
"type"
]
}
habitica_tasks_create_tasks_unlink_all_by_challenge_id
Unlink all tasks from a challenge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | The challenge _id |
keep | string | Yes | — | Specifies if tasks should be kept(keep-all) or removed(remove-all) after the unlink. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"challengeId": {
"type": "string",
"description": "The challenge _id"
},
"keep": {
"type": "string",
"description": "Specifies if tasks should be kept(keep-all) or removed(remove-all) after the unlink.",
"enum": [
"keep-all",
"remove-all"
]
}
},
"required": [
"PCID",
"challengeId",
"keep"
]
}
habitica_tasks_create_tasks_unlink_one_by_task_id
Unlink a challenge task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The task _id or alias |
keep | string | No | — | Specifies if the task should be kept(keep) or removed(remove) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
},
"keep": {
"type": "string",
"description": "Specifies if the task should be kept(keep) or removed(remove)",
"enum": [
"keep",
"remove"
]
}
},
"required": [
"PCID",
"taskId"
]
}
habitica_tasks_create_tasks_user
Create a new task belonging to the user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
alias | string | No | — | Alias to assign to task. |
attribute | string | No | — | User’s attribute to use, options are: str, int, per, con |
checklist | object[] | No | — | An array of checklist items. |
collapseChecklist | boolean | No | — | Determines if a checklist will be displayed. |
date | string | No | — | Due date to be shown in task list. Only valid for type “todo.” |
daysOfMonth | number[] | No | — | Array of integers. Only valid for type “daily”. |
down | boolean | No | — | Only valid for type “habit” If true, enables the ”-” under “Directions/Action” for “Bad habits”. |
everyX | number | No | — | Value of frequency must be “daily”, the number of days until this daily task is available again. |
frequency | string | No | — | Values “weekly” and “monthly” enable use of the “repeat” field. All frequency values enable use of the “everyX” field. Value “monthly” enables use of the “weeksOfMonth” and “daysOfMonth” fields. Frequency is only valid for type “daily”. |
notes | string | No | — | Additional notes or details about the task. |
priority | number | No | — | Difficulty, options are 0.1, 1, 1.5, 2; equivalent of Trivial, Easy, Medium, Hard. |
reminders | object[] | No | — | Array of reminders, each an object that must include: a UUID, startDate and time. |
repeat | object | No | — | Days of the week to repeat. Keys: su, m, t, w, th, f, s. Values: true/false. Only valid for type “daily” with frequency “weekly”. |
startDate | string | No | — | Date when the task will first become available. Only valid for type “daily”. |
streak | number | No | — | Number of days that the task has consecutively been checked off. Only valid for type “daily”. |
tags | string[] | No | — | Array of UUIDs of tags. |
text | string | Yes | — | The text to be displayed for the task. |
type | string | Yes | — | Task type, options are: habit, daily, todo, reward. |
up | boolean | No | — | Only valid for type “habit” If true, enables the ”+” under “Directions/Action” for “Good habits”. |
value | number | No | — | Only valid for type “reward.” The cost in gold of the reward. Should be greater then or equal to 0. |
weeksOfMonth | integer[] | No | — | Array of integers. Only valid for type “daily”. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"alias": {
"type": "string",
"description": "Alias to assign to task."
},
"attribute": {
"type": "string",
"description": "User's attribute to use, options are: `str`, `int`, `per`, `con`",
"enum": [
"str",
"int",
"per",
"con"
]
},
"checklist": {
"type": "array",
"items": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "The text description of the checklist item."
},
"completed": {
"type": "boolean",
"description": "Indicates whether the checklist item is completed or not."
}
}
},
"description": "An array of checklist items."
},
"collapseChecklist": {
"type": "boolean",
"description": "Determines if a checklist will be displayed."
},
"date": {
"type": "string",
"description": "Due date to be shown in task list. Only valid for type \"todo.\""
},
"daysOfMonth": {
"type": "array",
"items": {
"type": "number"
},
"description": "Array of integers. Only valid for type \"daily\"."
},
"down": {
"type": "boolean",
"description": "Only valid for type \"habit\" If true, enables the \"-\" under \"Directions/Action\" for \"Bad habits\"."
},
"everyX": {
"type": "number",
"description": "Value of frequency must be \"daily\", the number of days until this daily task is available again."
},
"frequency": {
"type": "string",
"description": "Values \"weekly\" and \"monthly\" enable use of the \"repeat\" field. All frequency values enable use of the \"everyX\" field. Value \"monthly\" enables use of the \"weeksOfMonth\" and \"daysOfMonth\" fields. Frequency is only valid for type \"daily\".",
"enum": [
"daily",
"weekly",
"monthly",
"yearly"
]
},
"notes": {
"type": "string",
"description": "Additional notes or details about the task."
},
"priority": {
"type": "number",
"description": "Difficulty, options are 0.1, 1, 1.5, 2; equivalent of Trivial, Easy, Medium, Hard.",
"enum": [
0.1,
1,
1.5,
2
]
},
"reminders": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "The id value"
},
"startDate": {
"type": "string",
"format": "date",
"description": "Start date for filtering"
},
"time": {
"type": "string",
"format": "date",
"description": "The time value"
}
}
},
"description": "Array of reminders, each an object that must include: a UUID, startDate and time."
},
"repeat": {
"type": "object",
"description": "Days of the week to repeat. Keys: su, m, t, w, th, f, s. Values: true/false. Only valid for type \"daily\" with frequency \"weekly\".",
"properties": {
"su": {
"type": "boolean",
"description": "The su value"
},
"m": {
"type": "boolean",
"description": "The m value"
},
"t": {
"type": "boolean",
"description": "The t value"
},
"w": {
"type": "boolean",
"description": "The w value"
},
"th": {
"type": "boolean",
"description": "The th value"
},
"f": {
"type": "boolean",
"description": "The f value"
},
"s": {
"type": "boolean",
"description": "The s value"
}
}
},
"startDate": {
"type": "string",
"description": "Date when the task will first become available. Only valid for type \"daily\"."
},
"streak": {
"type": "number",
"description": "Number of days that the task has consecutively been checked off. Only valid for type \"daily\"."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of UUIDs of tags."
},
"text": {
"type": "string",
"description": "The text to be displayed for the task."
},
"type": {
"type": "string",
"description": "Task type, options are: `habit`, `daily`, `todo`, `reward`.",
"enum": [
"habit",
"daily",
"todo",
"reward"
]
},
"up": {
"type": "boolean",
"description": "Only valid for type \"habit\" If true, enables the \"+\" under \"Directions/Action\" for \"Good habits\"."
},
"value": {
"type": "number",
"description": "Only valid for type \"reward.\" The cost in gold of the reward. Should be greater then or equal to 0."
},
"weeksOfMonth": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of integers. Only valid for type \"daily\"."
}
},
"required": [
"PCID",
"text",
"type"
]
}
habitica_tasks_delete_by_task_id
Delete a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The task _id or alias |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
}
},
"required": [
"PCID",
"taskId"
]
}
habitica_tasks_delete_by_task_id_checklist_by_item_id
Delete a checklist item from a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The task _id or alias |
itemId | string | Yes | — | The checklist item _id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
},
"itemId": {
"type": "string",
"description": "The checklist item _id"
}
},
"required": [
"PCID",
"taskId",
"itemId"
]
}
habitica_tasks_delete_by_task_id_tags_by_tag_id
Delete a tag from a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The task _id or alias |
tagId | string | Yes | — | The tag id |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
},
"tagId": {
"type": "string",
"description": "The tag id"
}
},
"required": [
"PCID",
"taskId",
"tagId"
]
}
habitica_tasks_delete_tags_by_tag_id
Delete a user tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tagId | string | Yes | — | The ID of the tag. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tagId": {
"type": "string",
"description": "The ID of the tag."
}
},
"required": [
"PCID",
"tagId"
]
}
habitica_tasks_get_by_task_id
Get a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The task _id or alias |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
}
},
"required": [
"PCID",
"taskId"
]
}
habitica_tasks_get_challenge_by_challenge_id
Get a challenge’s tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | The id of the challenge |
type | string | No | — | Query parameter to return just a type of tasks. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"challengeId": {
"type": "string",
"description": "The id of the challenge"
},
"type": {
"type": "string",
"description": "Query parameter to return just a type of tasks.",
"enum": [
"habits",
"dailys",
"todos",
"rewards"
]
}
},
"required": [
"PCID",
"challengeId"
]
}
habitica_tasks_get_group_by_group_id
Get a group’s tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted) |
type | string | No | — | Query parameter to return just a type of tasks. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"groupId": {
"type": "string",
"description": "The group id ('party' for the user party and 'habitrpg' for tavern are accepted)"
},
"type": {
"type": "string",
"description": "Query parameter to return just a type of tasks.",
"enum": [
"habits",
"dailys",
"todos",
"rewards"
]
}
},
"required": [
"PCID",
"groupId"
]
}
habitica_tasks_get_tags
Get all user’s tagsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
habitica_tasks_get_tags_by_tag_id
Get a Tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tagId | string | Yes | — | The ID of the tag. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tagId": {
"type": "string",
"description": "The ID of the tag."
}
},
"required": [
"PCID",
"tagId"
]
}
habitica_tasks_get_user
Get user’s tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | No | — | Optional query parameter to return just a type of tasks. By default all types will be returned except completed todos that must be requested separately. The “completedTodos” type returns only the 30 most recently completed. |
dueDate | string | No | — | Optional date to use for computing the nextDue field for each returned task. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"type": {
"type": "string",
"description": "Optional query parameter to return just a type of tasks. By default all types will be returned except completed todos that must be requested separately. The \"completedTodos\" type returns only the 30 most recently completed.",
"enum": [
"habits",
"dailys",
"todos",
"rewards",
"completedTodos"
]
},
"dueDate": {
"type": "string",
"description": "Optional date to use for computing the nextDue field for each returned task."
}
},
"required": [
"PCID"
]
}
habitica_tasks_update_tags_by_tag_id
Update Tag Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
tagId | string | Yes | — | The ID of the tag. |
name | string | No | — | The name of the new tag. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"tagId": {
"type": "string",
"description": "The ID of the tag."
},
"name": {
"type": "string",
"description": "The name of the new tag."
}
},
"required": [
"PCID",
"tagId"
]
}
habitica_tasks_update_tasks_by_task_id
Update a task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The task _id or alias |
attribute | string | No | — | User’s attribute to use, options are: str, int, per, con |
collapseChecklist | boolean | No | — | Determines if a checklist will be displayed |
date | string | No | — | Due date to be shown in task list. Only valid for type “todo” |
daysOfMonth | integer[] | No | — | Array of integers. Only valid for type “daily” |
down | boolean | No | — | Only valid for type “habit” If true, enables the ”-” under “Directions/Action” for “Bad habits” |
everyX | integer | No | — | Value of frequency must be “daily”, the number of days until this daily task is available again |
frequency | string | No | — | Values “weekly” and “monthly” enable use of the “repeat” field. All frequency values enable use of the “everyX” field. Value “monthly” enables use of the “weeksOfMonth” and “daysOfMonth” fields. Frequency is only valid for type “daily”. |
notes | string | No | — | Extra notes |
priority | number | No | — | Difficulty, options are 0.1, 1, 1.5, 2; equivalent of Trivial, Easy, Medium, Hard |
reminders | string[] | No | — | Array of reminders, each an object that must include: a UUID, startDate and time.\nFor example: {“id”:“ed427623-9a69-4aac-9852-13deb9c190c3”, “startDate”:“1/16/17”,“time”:“1/16/17” } |
repeat | object | No | — | Days of the week to repeat. Keys: su, m, t, w, th, f, s. Values: true/false. Only valid for type “daily” with frequency “weekly”. |
startDate | string | No | — | Date when the task will first become available. Only valid for type “daily” |
streak | integer | No | — | Number of days that the task has consecutively been checked off. Only valid for type “daily” |
text | string | No | — | The text to be displayed for the task |
type | string | No | — | Task type, options are: habit, daily, todo, reward |
up | boolean | No | — | Only valid for type “habit” If true, enables the ”+” under “Directions/Action” for “Good habits” |
value | integer | No | — | Only valid for type “reward.” The cost in gold of the reward |
weeksOfMonth | integer[] | No | — | Array of integers. Only valid for type “daily” |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
},
"attribute": {
"type": "string",
"description": "User's attribute to use, options are: `str`, `int`, `per`, `con`",
"enum": [
"str",
"int",
"per",
"con"
]
},
"collapseChecklist": {
"type": "boolean",
"description": "Determines if a checklist will be displayed"
},
"date": {
"type": "string",
"description": "Due date to be shown in task list. Only valid for type \"todo\""
},
"daysOfMonth": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of integers. Only valid for type \"daily\""
},
"down": {
"type": "boolean",
"description": "Only valid for type \"habit\" If true, enables the \"-\" under \"Directions/Action\" for \"Bad habits\""
},
"everyX": {
"type": "integer",
"description": "Value of frequency must be \"daily\", the number of days until this daily task is available again"
},
"frequency": {
"type": "string",
"description": "Values \"weekly\" and \"monthly\" enable use of the \"repeat\" field. All frequency values enable use of the \"everyX\" field. Value \"monthly\" enables use of the \"weeksOfMonth\" and \"daysOfMonth\" fields. Frequency is only valid for type \"daily\".",
"enum": [
"daily",
"weekly",
"monthly",
"yearly"
]
},
"notes": {
"type": "string",
"description": "Extra notes"
},
"priority": {
"type": "number",
"description": "Difficulty, options are 0.1, 1, 1.5, 2; equivalent of Trivial, Easy, Medium, Hard",
"enum": [
0.1,
1,
1.5,
2
]
},
"reminders": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of reminders, each an object that must include: a UUID, startDate and time.\\nFor example: {\"id\":\"ed427623-9a69-4aac-9852-13deb9c190c3\", \"startDate\":\"1/16/17\",\"time\":\"1/16/17\" }"
},
"repeat": {
"type": "object",
"description": "Days of the week to repeat. Keys: su, m, t, w, th, f, s. Values: true/false. Only valid for type \"daily\" with frequency \"weekly\".",
"properties": {
"su": {
"type": "boolean",
"description": "The su value"
},
"m": {
"type": "boolean",
"description": "The m value"
},
"t": {
"type": "boolean",
"description": "The t value"
},
"w": {
"type": "boolean",
"description": "The w value"
},
"th": {
"type": "boolean",
"description": "The th value"
},
"f": {
"type": "boolean",
"description": "The f value"
},
"s": {
"type": "boolean",
"description": "The s value"
}
}
},
"startDate": {
"type": "string",
"description": "Date when the task will first become available. Only valid for type \"daily\""
},
"streak": {
"type": "integer",
"description": "Number of days that the task has consecutively been checked off. Only valid for type \"daily\""
},
"text": {
"type": "string",
"description": "The text to be displayed for the task"
},
"type": {
"type": "string",
"description": "Task type, options are: `habit`, `daily`, `todo`, `reward`",
"enum": [
"habit",
"daily",
"todo",
"reward"
]
},
"up": {
"type": "boolean",
"description": "Only valid for type \"habit\" If true, enables the \"+\" under \"Directions/Action\" for \"Good habits\""
},
"value": {
"type": "integer",
"description": "Only valid for type \"reward.\" The cost in gold of the reward"
},
"weeksOfMonth": {
"type": "array",
"items": {
"type": "integer"
},
"description": "Array of integers. Only valid for type \"daily\""
}
},
"required": [
"PCID",
"taskId"
]
}
habitica_tasks_update_tasks_by_task_id_checklist_by_item_id
Update a checklist item Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
taskId | string | Yes | — | The task _id or alias |
itemId | string | Yes | — | The checklist item _id |
completed | boolean | No | — | Whether the checklist item is checked off |
text | string | No | — | The text of the checklist item |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"taskId": {
"type": "string",
"description": "The task _id or alias"
},
"itemId": {
"type": "string",
"description": "The checklist item _id"
},
"completed": {
"type": "boolean",
"description": "Whether the checklist item is checked off"
},
"text": {
"type": "string",
"description": "The text of the checklist item"
}
},
"required": [
"PCID",
"taskId",
"itemId"
]
}