/habitica-social | Type: Application | PCID required: Yes
Tools
habitica_social_create_challenges
Create a challenge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | A detailed description of the challenge. |
group | string | Yes | — | The UUID of the group to which the challenge belongs. |
name | string | Yes | — | The full name of the challenge. |
official | boolean | No | — | Specifies whether the challenge is an official Habitica challenge. |
prize | number | No | — | The prize or reward associated with the challenge. |
shortName | string | Yes | — | A shortened name for the challenge, to be used as a tag. |
summary | string | No | — | A short summary advertising the main purpose of the challenge; maximum 250 characters; if not supplied, challenge.name will be used. |
habitica_social_create_challenges_by_challenge_id_clone
Clone a challenge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | ID of the challenge to clone |
habitica_social_create_challenges_by_challenge_id_join
Join a challenge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | ID of the challenge |
habitica_social_create_challenges_by_challenge_id_leave
Leave Challenge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | ID of the challenge to leave |
keep | string | No | — | Specify whether to remove all or keep all challenge-related tasks upon leaving. |
habitica_social_create_challenges_by_challenge_id_select_winner_by_winner_id
Select Challenge Winner Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | The Challenge ID for the challenge to close with a winner. |
winnerId | string | Yes | — | The User ID of the winning user. |
habitica_social_create_groups
Create a Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The name of the new group. |
privacy | string | Yes | — | Privacy of group (party MUST be private) |
type | string | Yes | — | Type of group (guild or party) |
habitica_social_create_groups_by_group_id_add_manager
Add Group Manager Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted) |
managerId | string | Yes | — | The UUID of the user. |
habitica_social_create_groups_by_group_id_chat
Send a chat message in 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) |
previousMsg | string | No | — | The previous chat message’s UUID which will force a return of the full group chat. |
message | string | No | — | The content of the chat message. |
habitica_social_create_groups_by_group_id_chat_by_chat_id_clearflags
Clear flags Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted) |
chatId | string | Yes | — | The UUID of the chat message to clear flags from. |
habitica_social_create_groups_by_group_id_chat_by_chat_id_flag
Flag a group chat message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted). |
chatId | string | Yes | — | The chat message id. |
name | string | No | — | Explanation why the message was flagged. |
habitica_social_create_groups_by_group_id_chat_by_chat_id_like
Like Group Chat Message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted) |
chatId | string | Yes | — | The UUID of the chat message to like. |
habitica_social_create_groups_by_group_id_chat_seen
Mark Group Chat Messages as Seen Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted) |
habitica_social_create_groups_by_group_id_invite
Invite users 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) |
emails | object[] | No | — | An array of objects, each representing one email address to invite. |
uuids | string[] | No | — | An array of user IDs to invite. |
habitica_social_create_groups_by_group_id_join
Join 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) |
habitica_social_create_groups_by_group_id_leave
Leave 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) |
keep | string | No | — | Specify whether to remove or keep challenges when leaving the group. |
keepChallenges | string | No | — | Specify whether to remain in challenges or leave challenges upon leaving the group. |
habitica_social_create_groups_by_group_id_quests_abort
Abort Group Quest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group _id (or ‘party’) |
habitica_social_create_groups_by_group_id_quests_accept
Accept Group Quest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group _id (or ‘party’) |
habitica_social_create_groups_by_group_id_quests_cancel
Cancel Group Quest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group _id (or ‘party’) |
habitica_social_create_groups_by_group_id_quests_force_start
Force-Start Group Quest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group _id (or ‘party’) |
habitica_social_create_groups_by_group_id_quests_invite_by_quest_key
Invite users to a quest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group _id (or ‘party’) |
questKey | string | Yes | — | The unique key of the quest. |
habitica_social_create_groups_by_group_id_quests_leave
Leave Group Quest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group _id (or ‘party’) |
habitica_social_create_groups_by_group_id_quests_reject
Reject Group Quest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group _id (or ‘party’) |
habitica_social_create_groups_by_group_id_reject_invite
Reject a group invitation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted) |
habitica_social_create_groups_by_group_id_remove_manager
Remove a manager from 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) |
managerId | string | Yes | — | The UUID of the user. |
habitica_social_create_groups_by_group_id_remove_member_by_member_id
Remove a member from 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) |
memberId | string | Yes | — | The ID of the member to be removed from the group. |
message | string | No | — | The message to send to the removed members. |
habitica_social_create_groups_create_plan
Create Group Plan Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
description | string | No | — | The description of the group plan. |
gems | integer | No | — | The number of gems required for the plan. |
interval | string | No | — | The interval of the plan in cron syntax. |
name | string | No | — | The name of the group plan. |
habitica_social_create_groups_party_chat
Send a chat message to the party Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
previousMsg | string | No | — | The previous chat message’s UUID which will force a return of the full group chat. |
message | string | No | — | The content of the chat message. |
habitica_social_create_members_send_private_message
Send Private Message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
message | string | Yes | — | The private message to be sent. |
toUserId | string | Yes | — | The UUID of the user to whom the message will be sent. |
habitica_social_create_members_transfer_gems
Transfer Gems Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
gemAmount | integer | No | — | The number of gems to send |
message | string | No | — | The message to the user |
toUserId | string | No | — | The user to send the gift to |
habitica_social_delete_challenges_by_challenge_id
Delete a challenge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | ID of the challenge to retrieve |
habitica_social_delete_groups_by_group_id_chat_by_chat_id
Delete chat message from 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) |
chatId | string | Yes | — | The UUID of the chat message to delete. |
previousMsg | string | No | — | The last message’s ID fetched by the client so that the whole chat will be returned only if new messages have been posted in the meantime. |
habitica_social_get_challenges_by_challenge_id
Get challenges for a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | ID of the challenge to retrieve |
habitica_social_get_challenges_by_challenge_id_export_csv
Export Challenge to CSV Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | ID of the challenge to export |
habitica_social_get_challenges_by_challenge_id_members
Get members for a challenge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | The UUID of the challenge whose members are to be retrieved. |
lastId | string | No | — | Query parameter to specify the last member returned in a previous request to this route and get the next batch of results. |
limit | integer | No | — | BETA Query parameter to specify the number of results to return. Max is 60. |
includeTasks | boolean | No | — | BETA Query parameter - If ‘true’ then include challenge tasks of each member. |
includeAllPublicFields | boolean | No | — | If set to true then all public fields for members will be returned (similar to when making a request for a single member). |
habitica_social_get_challenges_by_challenge_id_members_by_member_id
Get a challenge member progress Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | The ID of the challenge. |
memberId | string | Yes | — | The ID of the challenge member. |
habitica_social_get_challenges_groups_by_group_id
Get challenges for 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). |
habitica_social_get_challenges_user
Get challenges for a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | number | Yes | — | This parameter can be used to specify the page number for the user challenges result (the initial page is number 0). |
member | string | No | — | If set to true it limits results to challenges where the user is a member. |
owned | string | No | — | If set to owned it limits results to challenges owned by the user. If set to not_owned it limits results to challenges not owned by the user. |
search | string | No | — | Optional query parameter to filter results to challenges that include (even partially) the search query parameter in the name or description. |
categories | string | No | — | Optional comma separated list of categories. If set it limits results to challenges that are part of the given categories. |
habitica_social_get_group_plans
Get Group Planshabitica_social_get_groups
Get user’s groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | — | Type of groups to retrieve (party, guilds, privateGuilds, publicGuilds, tavern) |
paginate | boolean | No | — | Whether to paginate the results (true or false) |
page | integer | No | — | Page number for paginated results (if paginate is true) |
habitica_social_get_groups_by_group_id
Get group information Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted) |
habitica_social_get_groups_by_group_id_chat
Get group chat messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted) |
habitica_social_get_groups_by_group_id_invites
Get invites for a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group id (‘party’ for the user party is accepted) |
lastId | string | No | — | Query parameter to specify the last invite returned in a previous request to this route and get the next batch of results. |
limit | integer | No | — | BETA Query parameter to specify the number of results to return. Max is 60. |
includeAllPublicFields | boolean | No | — | If set to true then all public fields for members will be returned (similar to when making a request for a single member). |
habitica_social_get_groups_by_group_id_members
Get members for a group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group id (‘party’ for the user party is accepted) |
lastId | string | No | — | Query parameter to specify the last member returned in a previous request to this route and get the next batch of results. |
limit | integer | No | — | BETA Query parameter to specify the number of results to return. Max is 60. |
includeTasks | boolean | No | — | BETA Query parameter - If ‘true’ then include challenge tasks of each member. |
includeAllPublicFields | boolean | No | — | If set to true then all public fields for members will be returned (similar to when making a request for a single member). |
habitica_social_get_groups_party_chat
Get party chat messageshabitica_social_get_looking_for_party
Get users in search of parties Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | number | No | — | Page number, defaults to 0. |
habitica_social_get_members_by_member_id
Get habitica member by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
memberId | string | Yes | — | ID of the member to retrieve |
habitica_social_get_members_by_member_id_achievements
Get member achievements object Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
memberId | string | Yes | — | The ID of the member whose achievements are to be retrieved. |
habitica_social_get_members_by_to_user_id_objections_by_interaction
Get objections to interaction Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
toUserId | string | Yes | — | The user to interact with |
interaction | string | Yes | — | Name of the interaction to query. |
habitica_social_update_challenges_by_challenge_id
Update a challenge Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
challengeId | string | Yes | — | ID of the challenge to retrieve |
description | string | No | — | The new challenge description. |
name | string | No | — | The new full name of the challenge. |
summary | string | No | — | The new challenge summary. |
habitica_social_update_groups_by_group_id
Update Group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
groupId | string | Yes | — | The group _id (‘party’ for the user party and ‘habitrpg’ for tavern are accepted) |
name | string | Yes | — | The name of the new group. |
privacy | string | Yes | — | Privacy of group (party MUST be private) |
type | string | Yes | — | Type of group (guild or party) |

