Integration · Communication

Connect Claude & ChatGPT to Mattermost

Ask your AI what was decided in a channel, to search posts for an old discussion or to post an update. It can read and search Mattermost posts and threads, post and edit messages, open direct and group messages, create and update channels, add members, pin posts and add reactions. It works with your own Mattermost server.

Connect Mattermost free

Free plan, no credit card. Takes about a minute.

Try asking

“What was decided in release-planning this week?”
The AI finds the channel by name, reads the posts since the start of the week and sums up the decisions.
“Search for posts about the database migration.”
It searches the team's posts for the terms and shows the matches.
“Post in the deploys channel: version 2.4 is live.”
It posts the message in the channel. Channel members see it immediately.

What your AI can do

Posts and threads

Read recent posts, whole threads and saved posts, search posts in a team, and post, edit, pin or delete messages.

Channels and teams

List your teams and channels, search public channels, create and update channels and add members.

Users and direct messages

Search users, see their status, and open direct or group messages to post in.

“Send Peter a direct message asking for the Q3 numbers.”
It finds Peter, opens a direct message channel with him and posts your message.
“Create a private channel for the audit and add Maria and Jonas.”
It creates the private channel in the team and adds both users.
“What is pinned in the onboarding channel?”
It lists the pinned posts in the channel.

616 tools for Mattermost

These tools are switched on when you connect. You can switch any of them off, or require your approval before it runs.

add_channel_membersChanges dataAdd a user (`user_id`) or several users (`user_ids`) to a channel by `channel_id`.
add_reactionChanges dataAdd an emoji reaction (`emoji_name`) to a post (`post_id`) as a user (`user_id`).
approve_remotecluster_inviteVisible to othersAccept a remotecluster. Has effects visible outside this system. API summary: Accept a remote cluster invite code.
approve_remotecluster_invite_confirmVisible to othersConfirm a remotecluster. Has effects visible outside this system. API summary: Confirm an invite with a remote cluster.
archive_botVisible to othersDisable a bot (bot user id). Has effects visible outside this system.
archive_pluginVisible to othersDisable a plugin (plugin id). Has effects visible outside this system. API summary: Disable plugin.
archive_userDeletesDisable a user. Destructive action; may require approval. API summary: Disable personal access token.
attach_access_control_policyChanges dataAssign a access control policy (policy id). API summary: Assign an access control policy to channels or teams.
attach_assign_to_botChanges dataAttach a assign (user id). API summary: Assign a bot to a user.
attach_channel_to_groupChanges dataLink a channel (channel id). API summary: Link a channel to a group.
attach_channel_to_group_linkDeletesLink a channel (channel id). Destructive action; may require approval. API summary: Unlink a channel from a group.
attach_deviceVisible to othersAttach a device. Has effects visible outside this system. API summary: Attach mobile device and extra props to the session object.
attach_documentChanges dataLink a document (file id). API summary: Get a public file link.
attach_groupChanges dataLink a group (remote id). API summary: Link a LDAP group.
attach_team_to_groupChanges dataLink a team (team id). API summary: Link a team to a group.
attach_team_to_group_linkDeletesLink a team (team id). Destructive action; may require approval. API summary: Unlink a team from a group.
cancel_projectDeletesCancel a project (job id). Destructive action; may require approval. API summary: Cancel a job.
create_a_custom_groupChanges dataCreate a new group. Required: name, display name, source, allow reference or user ids. Search groups first to avoid duplicates. API summary: Create a custom group.
create_a_ephemeral_postChanges dataCreate a new page. Required: user id or post. Search pages first to avoid duplicates. API summary: Create a ephemeral post.
create_a_new_jobChanges dataCreate a new project. Required: type. API summary: Create a new job.
create_a_userChanges dataCreate a new user. Required: email or username. Search users first to avoid duplicates. API summary: Create a user.
create_a_user_access_tokenDeletesCreate a new user for a user. Required: description. Search users first to avoid duplicates. Destructive action; may require approval. API summary: Create a user access token.
create_ackChanges dataCreate a new ack. API summary: Acknowledge receiving of a notification.
create_allChanges dataCreate a new all. API summary: Revoke all active sessions for a user.
create_all_revoke_sessions_from_all_usersChanges dataCreate a new all. API summary: Revoke all sessions from all users.
create_ancillaryDeletesCreate a new ancillary. Required: items. Destructive action; may require approval. API summary: Return all system console subsection ancillary permissions.
create_appChanges dataCreate a new app. Required: name, description, callback urls or homepage. API summary: Register OAuth app.
create_app_regen_secretChanges dataCreate a new regen secret for a app. API summary: Regenerate OAuth app secret.
create_batchVisible to othersCreate a new batch. Required: items. Has effects visible outside this system. API summary: Add multiple users to team.
create_boardChanges dataCreate a new board. Required: team id, type or display name. API summary: Create a board channel.
create_bookmark_orderChanges dataCreate a new order for a bookmark. API summary: Update channel bookmark's order.
create_botChanges dataCreate a new bot. Required: username. API summary: Create a bot.
create_bot_userChanges dataCreate a new user for a bot. Search users first to avoid duplicates. API summary: Convert a bot into a user.
create_categoryChanges dataCreate a new category. API summary: Create user's sidebar category.
create_channelChanges dataCreate a channel in a team (`team_id`) with `name` (URL handle), `display_name` and `type` (O public, P private), plus optional header and purpose.
create_channel_bookmarkChanges dataCreate a new bookmark for a channel. Required: display name or type. API summary: Create channel bookmark.
create_channel_convert_to_channelVisible to othersCreate a new convert to channel for a channel. Required: body channel id or team id. Has effects visible outside this system. API summary: Convert group message to private channel.
create_channel_inviteVisible to othersCreate a new invite for a channel. Has effects visible outside this system. API summary: Invites a remote cluster to a channel.
create_channel_moveChanges dataCreate a new move for a channel. Required: team id. API summary: Move a channel.
create_channel_uninviteChanges dataCreate a new uninvite for a channel. API summary: Uninvites a remote cluster to a channel.
create_channel_viewChanges dataCreate a new view for a channel. Required: title or type. API summary: Create channel view.
create_checkChanges dataCreate a new check. API summary: Check an access control policy expression.
create_checklist_addChanges dataCreate a new add for a checklist. Required: title. API summary: Add an item to a playbook run's checklist.
create_cleanupChanges dataCreate a new cleanup. API summary: Log an ephemeral mode cleanup run.
create_commandChanges dataCreate a new command. Required: team id, method, trigger or url. API summary: Create a command.
create_cwDeletesCreate a new cw. Destructive action; may require approval. API summary: Auto-Login to Mattermost server using CWS token.
create_deleteChanges dataCreate a new delete. Required: emoji, text, duration or expires at. API summary: Delete user's recent custom status.
create_dialogChanges dataCreate a new dialog. Search dialogs first to avoid duplicates. API summary: Create a new playbook run from dialog.
create_documentChanges dataCreate a new document. Required: channel id, filename or file size. Search documents first to avoid duplicates. API summary: Create an upload.
create_draftChanges dataCreate a new draft. Required: channel id or message. API summary: Upsert synced draft.
create_executeChanges dataCreate a new execute. Required: channel id or command. API summary: Execute a command.
create_execute_execute_dialog_actionChanges dataCreate a new execute. Required: url or channel id. API summary: Execute a dialog action button.
create_export_presign_urlChanges dataCreate a new presign url for a export. API summary: Create a presigned URL for export download.
create_first_admin_visitDeletesCreate a new first admin visit. Destructive action; may require approval. API summary: Stores that the Plugin Marketplace has been visited by at least an admin.
create_generateChanges dataCreate a new generate. API summary: Generate MFA secret.
create_group_channelChanges dataCreate a new group channel. Required: items. API summary: Get users by group channels ids.
create_group_propertyChanges dataCreate a new property for a group. Required: name, type or target type. Search properties first to avoid duplicates. API summary: Create a property field.
create_group_userChanges dataCreate a new user for a group. Search users first to avoid duplicates. API summary: Adds members to a custom group.
create_incomingDeletesCreate a new incoming. Required: channel id. Destructive action; may require approval. API summary: Create an incoming webhook.
create_install_from_urlChanges dataCreate a new install from url. Required: plugin download url. API summary: Install plugin from url.
create_integrityChanges dataCreate a new integrity. API summary: Perform a database integrity check.
create_invalidateChanges dataCreate a new invalidate. API summary: Invalidate all the caches.
create_inviteVisible to othersCreate a new invite. Has effects visible outside this system. API summary: Add user to team from invite.
create_ip_filteringChanges dataCreate a new ip filtering. Required: items. Search ip filterings first to avoid duplicates. API summary: Get all IP filters.
create_ldapChanges dataCreate a new ldap. Required: from, match field or force. API summary: Migrate user accounts authentication type to LDAP.
create_logChanges dataCreate a new log. Required: level or message. Search logs first to avoid duplicates. API summary: Add log message.
create_marketplaceChanges dataCreate a new marketplace. Required: id. Search marketplaces first to avoid duplicates. API summary: Installs a marketplace plugin.
create_member_countChanges dataCreate a new member count. Required: items. API summary: Get member counts for multiple channels.
create_metadatafromidpChanges dataCreate a new metadatafromidp. API summary: Get metadata from Identity Provider.
create_migrateChanges dataCreate a new migrate. Required: from or to. API summary: Migrate config storage.
create_migrateidChanges dataCreate a new migrateid. Required: to attribute. API summary: Migrate Id LDAP.
create_msgVisible to othersCreate a new msg. Has effects visible outside this system. API summary: Receive a remote cluster message.
create_nameChanges dataCreate a new name. Required: items. API summary: Get custom emojis by name.
create_openChanges dataCreate a new open. Required: trigger id, url or dialog. API summary: Open a dialog.
create_outgoingDeletesCreate a new outgoing. Required: team id, display name, trigger words or callback urls. Destructive action; may require approval. API summary: Create an outgoing webhook.
create_outgoing_connectionChanges dataCreate a new outgoing connection. Required: team id. API summary: Create a connection.
create_outgoing_regen_tokenDeletesCreate a new regen token for a outgoing. Destructive action; may require approval. API summary: Regenerate the token for the outgoing webhook.
create_pageDeletesCreate a new page. Search pages first to avoid duplicates. Destructive action; may require approval. API summary: Trigger notify-admin posts.
create_page_create_scheduled_postChanges dataCreate a new page. Required: scheduled at, channel id or message. Search pages first to avoid duplicates. API summary: Creates a scheduled post.
create_page_exposure_reportChanges dataCreate a new exposure report for a page. API summary: Generate and download a post exposure report.
create_page_flagChanges dataCreate a new flag for a page. API summary: Flag a post.
create_page_get_posts_for_reportingChanges dataCreate a new page. Required: channel id. Search pages first to avoid duplicates. API summary: Get posts for reporting and compliance purposes using cursor-based pagination.
create_page_moveChanges dataCreate a new move for a page. Required: channel id. API summary: Move a post (and any posts within that post's thread).
create_page_reminderChanges dataCreate a new reminder for a page. Required: target time. API summary: Set a post reminder.
create_page_reportChanges dataCreate a new report for a page. API summary: Generate and download a flagged post report.
create_page_save_acknowledgement_for_postChanges dataCreate a new page for a page. Search pages first to avoid duplicates. API summary: Acknowledge a post.
create_page_unpinChanges dataCreate a new unpin for a page. API summary: Unpin a post to the channel.
create_pingChanges dataCreate a new ping. API summary: Receive a ping from a remote cluster.
create_playbookChanges dataCreate a new playbook. Required: title, team id, create public playbook run, checklists or member ids. API summary: Create a playbook.
create_playbook_conditionChanges dataCreate a new condition for a playbook. Required: condition expr or version. API summary: Create a playbook condition.
create_playbook_propertyChanges dataCreate a new property for a playbook. Required: name or type. Search properties first to avoid duplicates. API summary: Create a property field for a playbook.
create_policyChanges dataCreate a new policy. API summary: Create a new granular data retention policy.
create_policy_channelChanges dataCreate a new channel for a policy. Required: items. Search channels first to avoid duplicates. API summary: Add channels to a granular data retention policy.
create_policy_teamChanges dataCreate a new team for a policy. Required: items. Search teams first to avoid duplicates. API summary: Add teams to a granular data retention policy.
create_postChanges dataPost a message (`message`) in a channel by `channel_id`. Set `root_id` to reply in a thread. Channel members see it immediately.
create_projectChanges dataCreate a new project. API summary: Get login authentication type.
create_propertyChanges dataCreate a new property. Required: name or type. Search properties first to avoid duplicates. API summary: Create a Custom Profile Attribute field.
create_property_reorder_playbook_property_fieldsChanges dataCreate a new property. Required: field id or target position. Search properties first to avoid duplicates. API summary: Reorder property fields for a playbook.
create_purgeChanges dataCreate a new purge. API summary: Log an ephemeral mode offline purge.
create_purge_indexChanges dataCreate a new purge index. API summary: Purge all Elasticsearch indexes.
create_reattachChanges dataCreate a new reattach. Required: manifest or plugin reattach config. API summary: Reattach a plugin process.
create_recapChanges dataCreate a new recap. Required: title, channel ids or agent id. API summary: Create a channel recap.
create_recap_readChanges dataCreate a new read for a recap. API summary: Mark a recap as read.
create_recap_regenerateChanges dataCreate a new regenerate for a recap. API summary: Regenerate a recap.
create_recycleChanges dataCreate a new recycle. API summary: Recycle database connections.
create_registerChanges dataCreate a new register. Required: redirect uris. API summary: Register OAuth client using Dynamic Client Registration.
create_reloadChanges dataCreate a new reload. API summary: Reload configuration.
create_remoteclusterChanges dataCreate a new remotecluster. Required: name or default team id. API summary: Create a new remote cluster.
create_remotecluster_generate_inviteVisible to othersCreate a new generate invite for a remotecluster. Required: password. Has effects visible outside this system. API summary: Generate invite code.
create_remotecluster_imageChanges dataCreate a new image for a remotecluster. API summary: Set profile image for a remote user.
create_reportChanges dataCreate a new report. API summary: Create report.
create_resetDeletesCreate a new reset. Required: code or new password. Destructive action; may require approval. API summary: Reset password.
create_reset_auth_dataVisible to othersCreate a new reset auth data. Has effects visible outside this system. API summary: Reset AuthData to Email.
create_restartChanges dataCreate a new restart. API summary: Restart the system after an upgrade from Team Edition to Enterprise Edition.
create_revokeChanges dataCreate a new revoke. Required: session id. API summary: Revoke a user session.
create_revoke_revoke_non_compliant_user_access_tokensDeletesCreate a new revoke. Destructive action; may require approval. API summary: Revoke non-compliant personal access tokens.
create_revoke_revoke_user_access_tokenDeletesCreate a new revoke. Required: token id. Destructive action; may require approval. API summary: Revoke a user access token.
create_rewriteVisible to othersCreate a new rewrite. Required: agent id, message or action. Has effects visible outside this system. API summary: Rewrite a message using AI.
create_runChanges dataCreate a new run. Required: name, owner user id, team id or playbook id. Search runs first to avoid duplicates. API summary: Create a new playbook run.
create_run_endChanges dataCreate a new end for a run. API summary: End a playbook run from dialog.
create_run_next_stage_dialogChanges dataCreate a new next stage dialog for a run. API summary: Go to next stage from dialog.
create_run_ownerChanges dataCreate a new owner for a run. Required: owner id. API summary: Update playbook run owner.
create_samlChanges dataCreate a new saml. Required: from, matches or auto. API summary: Migrate user accounts authentication type to SAML.
create_scheduled_recapChanges dataCreate a new scheduled recap. Required: title, days of week, time of day, timezone, time period or channel mode. API summary: Create a scheduled recap.
create_scheduled_recap_pauseChanges dataCreate a new pause for a scheduled recap. API summary: Pause a scheduled recap.
create_scheduled_recap_resumeChanges dataCreate a new resume for a scheduled recap. API summary: Resume a scheduled recap.
create_schemeChanges dataCreate a new scheme. Required: display name or scope. API summary: Create a scheme.
create_server_busyChanges dataCreate a new server busy. API summary: Set the server busy (high load) flag.
create_switchChanges dataCreate a new switch. Required: current service or new service. API summary: Switch login method.
create_teamChanges dataCreate a new team. Required: name, display name or type. Search teams first to avoid duplicates. API summary: Create a team.
create_team_regenerate_invite_idVisible to othersCreate a new regenerate invite id for a team. Has effects visible outside this system. API summary: Regenerate the Invite ID from a Team.
create_team_userChanges dataCreate a new user for a team. Search users first to avoid duplicates. API summary: Add user to team.
create_terms_of_serviceChanges dataCreate a new terms of service. API summary: Creates a new terms of service.
create_testVisible to othersCreate a new test. Has effects visible outside this system. API summary: Send a test email.
create_test_connectionChanges dataCreate a new test connection. API summary: Test LDAP connection with specific settings.
create_test_diagnosticChanges dataCreate a new test diagnostic. Required: test. API summary: Test LDAP diagnostics with specific settings.
create_test_test_access_control_policy_expressionChanges dataCreate a new test. API summary: Test an access control policy expression.
create_test_test_elasticsearchChanges dataCreate a new test. API summary: Test Elasticsearch configuration.
create_test_test_file_store_connectionChanges dataCreate a new test. API summary: Test the configured file storage backend.
create_test_test_ldapChanges dataCreate a new test. API summary: Test LDAP configuration.
create_test_test_site_urlChanges dataCreate a new test. Required: site url. API summary: Checks the validity of a Site URL.
create_trial_licenseChanges dataCreate a new trial license. Required: users. API summary: Request and install a trial license for your server.
create_upgrade_to_enterpriseChanges dataCreate a new upgrade to enterprise. API summary: Executes an inplace upgrade from Team Edition to Enterprise Edition.
create_userDeletesCreate a new user. Required: token. Search users first to avoid duplicates. Destructive action; may require approval. API summary: Login using desktop token.
create_user_convert_to_botChanges dataCreate a new convert to bot for a user. API summary: Convert a user into a bot.
create_user_demoteChanges dataCreate a new demote for a user. API summary: Demote a user to a guest.
create_user_login_intuneChanges dataCreate a new user. Required: access token. Search users first to avoid duplicates. API summary: Login with Microsoft Intune MAM.
create_user_promoteChanges dataCreate a new promote for a user. API summary: Promote a guest to user.
create_user_register_terms_of_service_actionChanges dataCreate a new user for a user. Required: service terms id or accepted. Search users first to avoid duplicates. API summary: Records user action when they accept or decline custom terms of service.
create_user_reset_failed_attemptDeletesCreate a new reset failed attempt for a user. Destructive action; may require approval. API summary: Reset the failed password attempts for a user.
create_user_rotate_user_access_tokenDeletesCreate a new user. Required: token id. Search users first to avoid duplicates. Destructive action; may require approval. API summary: Rotate a personal access token.
create_user_simulate_access_control_policy_for_usersChanges dataCreate a new user. Required: policy, actions or users. Search users first to avoid duplicates. API summary: Simulate an access control policy decision for an explicit user list.
create_user_subscriptionChanges dataCreate a new subscription for a user. API summary: Create memberships for LDAP configured channels and teams for this user.
create_user_verify_user_email_without_tokenDeletesCreate a new user. Search users first to avoid duplicates. Destructive action; may require approval. API summary: Verify user email by ID.
create_user_viewChanges dataCreate a new view for a user. Required: channel id. API summary: View channel.
create_view_orderChanges dataCreate a new order for a view. Required: body. API summary: Update a channel view's sort order.
create_visual_astChanges dataCreate a new visual ast. API summary: Get the visual AST for a CEL expression.
create_webhookDeletesCreate a new webhook. Destructive action; may require approval. API summary: POST endpoint for CWS Webhooks.
create_wipeChanges dataCreate a new wipe. Required: signature. API summary: Log an ephemeral mode session wipe.
delete_a_link_for_ldap_groupDeletesLink a group (remote id). Destructive action; may require approval. API summary: Delete a link for LDAP group.
delete_a_property_fieldDeletesPermanently delete a property by property id. Destructive action; may require approval. API summary: Delete a property field.
delete_a_scheduled_postDeletesPermanently delete a page by scheduled post id. Destructive action; may require approval. API summary: Delete a scheduled post.
delete_access_control_policyDeletesPermanently delete a access control policy by policy id. Destructive action; may require approval. API summary: Delete an access control policy.
delete_ai_bridgesMoves moneyPermanently delete a ai bridge. Financial or irreversible action; may require approval. API summary: Reset AI bridge E2E test helper.
delete_appDeletesPermanently delete a app by app id. Destructive action; may require approval. API summary: Delete an OAuth app.
delete_categoryDeletesPermanently delete a category by category id. Destructive action; may require approval. API summary: Delete sidebar category.
delete_certificatesMoves moneyPermanently delete a certificate. Financial or irreversible action; may require approval. API summary: Remove audit log certificate.
delete_channelDeletesPermanently delete a channel by channel id. Destructive action; may require approval.
delete_channel_bookmarkDeletesPermanently delete a bookmark by bookmark id. Destructive action; may require approval. API summary: Delete channel bookmark.
delete_channel_draftDeletesPermanently delete a draft by thread id. Destructive action; may require approval. API summary: Delete synced thread draft.
delete_channel_draftsMoves moneyPermanently delete a draft by channel id. Financial or irreversible action; may require approval. API summary: Delete synced draft.
delete_channel_userDeletesPermanently delete a user by user id. Destructive action; may require approval. API summary: Remove user from channel.
delete_channel_viewDeletesPermanently delete a view by view id. Destructive action; may require approval. API summary: Delete a channel view.
delete_checklist_productDeletesPermanently delete a product by item. Destructive action; may require approval. API summary: Delete an item of a playbook run's checklist.
delete_commandDeletesPermanently delete a command by command id. Destructive action; may require approval.
delete_customsMoves moneyPermanently delete a custom by user id. Financial or irreversible action; may require approval. API summary: Unsets user custom status.
delete_deletesDeletesPermanently delete a delete by user id. Destructive action; may require approval. API summary: Delete user's preferences.
delete_emojiDeletesPermanently delete a emoji by emoji id. Destructive action; may require approval. API summary: Delete a custom emoji.
delete_exportDeletesPermanently delete a export by export name. Destructive action; may require approval. API summary: Delete an export file.
delete_groupDeletesPermanently delete a group by group id. Destructive action; may require approval. API summary: Deletes a custom group.
delete_group_usersMoves moneyPermanently delete a user by group id. Financial or irreversible action; may require approval. API summary: Removes members from a custom group.
delete_idpsMoves moneyPermanently delete a idp. Financial or irreversible action; may require approval. API summary: Remove IDP certificate.
delete_imagesMoves moneyPermanently delete a image. Financial or irreversible action; may require approval. API summary: Delete current brand image.
delete_importDeletesPermanently delete a import by import name. Destructive action; may require approval. API summary: Delete an import file.
delete_incomingDeletesPermanently delete a incoming by hook id. Destructive action; may require approval. API summary: Delete an incoming webhook.
delete_licensesMoves moneyPermanently delete a license. Financial or irreversible action; may require approval. API summary: Remove license file.
delete_outgoingDeletesPermanently delete a outgoing by hook id. Destructive action; may require approval. API summary: Delete an outgoing webhook.
delete_outgoing_connectionDeletesPermanently delete a outgoing connection by outgoing oauth connection id. Destructive action; may require approval. API summary: Delete a connection.
delete_page_burnsMoves moneyPermanently delete a burn by post id. Financial or irreversible action; may require approval. API summary: Burn a burn-on-read post.
delete_page_removesMoves moneyPermanently delete a remove by post id. Financial or irreversible action; may require approval. API summary: Remove a flagged post.
delete_pagesMoves moneyPermanently delete a page by post id. Financial or irreversible action; may require approval. API summary: Delete a post acknowledgement.
delete_playbookDeletesPermanently delete a playbook by playbook id. Destructive action; may require approval.
delete_playbook_conditionDeletesPermanently delete a condition by condition id. Destructive action; may require approval. API summary: Delete a playbook condition.
delete_playbook_propertyDeletesPermanently delete a property by field id. Destructive action; may require approval. API summary: Delete a property field for a playbook.
delete_pluginDeletesPermanently delete a plugin by plugin id. Destructive action; may require approval. API summary: Remove plugin.
delete_policyDeletesPermanently delete a policy by policy id. Destructive action; may require approval. API summary: Delete a granular data retention policy.
delete_policy_channelsMoves moneyPermanently delete a channel by policy id. Financial or irreversible action; may require approval. API summary: Delete channels from a granular data retention policy.
delete_policy_teamsMoves moneyPermanently delete a team by policy id. Financial or irreversible action; may require approval. API summary: Delete teams from a granular data retention policy.
delete_postDeletesDelete a post by its post ID in `page_id`. This cannot be undone.
delete_privatesMoves moneyPermanently delete a private. Financial or irreversible action; may require approval. API summary: Remove private key.
delete_propertyDeletesPermanently delete a property by property id. Destructive action; may require approval. API summary: Delete a Custom Profile Attribute field.
delete_publicsMoves moneyPermanently delete a public. Financial or irreversible action; may require approval. API summary: Remove public certificate.
delete_recapDeletesPermanently delete a recap by recap id. Destructive action; may require approval.
delete_recentsMoves moneyPermanently delete a recent by user id. Financial or irreversible action; may require approval. API summary: Delete user's recent custom status.
delete_remoteclusterDeletesPermanently delete a remotecluster by remote id. Destructive action; may require approval. API summary: Delete a remote cluster.
delete_run_timelineDeletesPermanently delete a timeline by event id. Destructive action; may require approval. API summary: Remove a timeline event from the playbook run.
delete_scheduled_recapDeletesPermanently delete a scheduled recap by scheduled recap id. Destructive action; may require approval.
delete_schemeDeletesPermanently delete a scheme by scheme id. Destructive action; may require approval.
delete_server_busiesMoves moneyPermanently delete a server busy. Financial or irreversible action; may require approval. API summary: Clears the server busy (high load) flag.
delete_teamDeletesPermanently delete a team by team id. Destructive action; may require approval.
delete_team_imagesMoves moneyPermanently delete a image by team id. Financial or irreversible action; may require approval. API summary: Remove the team icon.
delete_team_userDeletesPermanently delete a user by user id. Destructive action; may require approval. API summary: Remove user from team.
delete_thread_followingsMoves moneyPermanently delete a following by thread id. Financial or irreversible action; may require approval. API summary: Stop following a thread.
delete_userDeletesPermanently delete a user by user id. Destructive action; may require approval. API summary: Deactivate a user account.
delete_user_imagesMoves moneyPermanently delete a image by user id. Financial or irreversible action; may require approval. API summary: Delete user's profile image.
delete_usersMoves moneyPermanently delete a user. Financial or irreversible action; may require approval. API summary: Permanent delete all users.
detach_access_control_policyDeletesUnassign a access control policy (policy id). Destructive action; may require approval. API summary: Unassign an access control policy from channels or teams.
detach_pluginChanges dataDetach a plugin (plugin id). API summary: Detach a reattached plugin process.
download_exportDownload the document for a export. API summary: Download an export file.
download_invoice_pdfDownload the pdf document for a invoice. API summary: Get cloud invoice PDF.
download_logDownload the document for a log. API summary: Download system logs.
download_projectDownload the document for a project. API summary: Download the results of a job.
download_reportDownload the document for a report. API summary: Download a report.
edit_postVisible to othersEdit a post by `post_id`: change its `message` text. Only the fields you pass change.
export_usersChanges dataExport users. API summary: Starts a job to export the users to a report file.
find_playbook_run_by_channel_idGet one channel by channel id. API summary: Find playbook run by channel ID.
get_a_channel_by_name_and_team_nameGet one name by channel name. API summary: Get a channel by name and team name.
get_a_custom_emoji_by_nameGet one name by emoji name. API summary: Get a custom emoji by name.
get_a_file_s_previewGet one document by file id. API summary: Get a file's preview.
get_a_flagged_post_with_all_its_contentGet one page by page id. API summary: Get a flagged post with all its content.
get_a_list_of_channels_by_idsChanges dataCreate a new user. Required: items. Search users first to avoid duplicates. API summary: Get a list of channels by ids.
get_a_list_of_roles_by_nameDeletesCreate a new name. Required: items. Destructive action; may require approval. API summary: Get a list of roles by name.
get_a_roleGet one name by role name. API summary: Get a role.
get_a_team_memberGet one user for a team by user id. API summary: Get a team member.
get_a_user_access_tokenGet one user by user id. API summary: Get a user access token.
get_a_user_by_auth_dataList users. Optional filters: value. API summary: Get a user by auth data.
get_a_user_by_usernameGet one user by username. API summary: Get a user by username.
get_access_control_attributes_for_a_channelList attributes. API summary: Get access control attributes for a channel.
get_access_control_policyGet one access control policy by policy id. API summary: Get an access control policy.
get_agent_statusGet the current status of a agent. API summary: Get agents bridge status.
get_an_upload_sessionGet one document by document id. API summary: Get an upload session.
get_appGet one app by app id. API summary: Get an OAuth app.
get_autocomplete_fields_for_access_control_policiesList properties. Results are paginated. API summary: Get autocomplete fields for access control policies.
get_botGet one bot by bot user id. API summary: Get a bot.
get_brand_imageList images. API summary: Get brand image.
get_categoryGet one category by category id. API summary: Get sidebar category.
get_certificate_statusGet the current status of a certificate. API summary: Get certificate status.
get_channelGet one channel by `channel_id`, including name, header and purpose.
get_channel_by_nameGet a channel by its handle `channel_name` in a team (`team_id`).
get_channel_members_by_idsChanges dataCreate a new user. Required: items. Search users first to avoid duplicates. API summary: Get channel members by ids.
get_channel_memberships_and_roles_for_a_userList users. API summary: Get channel memberships and roles for a user.
get_channel_userGet one user for a channel by user id. API summary: Get channel member.
get_channel_viewGet one view for a channel by view id. API summary: Get a channel view.
get_channels_for_an_access_control_policyList channels. Results are paginated. API summary: Get channels for an access control policy.
get_client_licenseList customers. API summary: Get client license.
get_cloud_customerList customers. API summary: Get cloud customer.
get_cluster_statusGet the current status of a cluster. API summary: Get cluster status.
get_commandGet one command by command id. API summary: Get a command.
get_content_flagging_configurationList shipments. API summary: Get content flagging configuration.
get_content_flagging_property_fieldsList properties. API summary: Get content flagging property fields.
get_current_usage_of_postsList pages. API summary: Get current usage of posts.
get_current_usage_of_teamsList teams. API summary: Get current usage of teams.
get_documentGet one document by document id. API summary: Get a file.
get_emojiGet one emoji by emoji id. API summary: Get a custom emoji.
get_groupGet one group by group id. API summary: Get a group.
get_group_channelGet one channel for a group by channel id. API summary: Get a channel syncable for a group.
get_group_teamGet one team for a group by team id. API summary: Get a team syncable for a group.
get_groupsSearch groups by q, include member count, not associated to team, not associated to channel, since or filter allow reference. Use this to find existing groups before creating a new group. Results are paginated. API summary: Get groups.
get_groups_by_nameChanges dataCreate a new name. Required: items. API summary: Get groups by name.
get_incomingGet one incoming by hook id. API summary: Get an incoming webhook.
get_inviteGet one invite by invite id. API summary: Get invite info for a team.
get_messageGet one message by email. API summary: Get a user by email.
get_nameGet one name by team name. API summary: Get a team by name.
get_non_compliantGet one non compliant. API summary: Count non-compliant personal access tokens.
get_noticeGet one notice by team id. API summary: Get notices for logged in user in specified team.
get_onboardingGet one onboarding. API summary: Get first admin onboarding completion status.
get_outgoingGet one outgoing by hook id. API summary: Get an outgoing webhook.
get_outgoing_connectionGet one outgoing connection by outgoing oauth connection id. API summary: Get a connection.
get_playbookGet one playbook by playbook id. API summary: Get a playbook.
get_playbook_run_channelsSearch channels by team id, sort, direction, status, owner user id or search term. Use this to find existing channels before creating a new channel. API summary: Get playbook run channels.
get_policyGet one policy by policy id. API summary: Get a granular data retention policy.
get_postGet one post by its post ID in `page_id`.
get_post_infoList pages for a page. API summary: Get post info.
get_post_threadGet a post and all its replies by `post_id`.
get_posts_around_oldest_unreadList pages. Optional filters: limit before, limit after, skip fetch threads, collapsed threads, collapsed threads extended or property group. API summary: Get posts around oldest unread.
get_posts_by_a_list_of_idsChanges dataCreate a new user. Required: items. Search users first to avoid duplicates. API summary: Get posts by a list of ids.
get_preference_nameGet one name for a preference by preference name. API summary: Get a specific user preference.
get_projectGet one project by project id. API summary: Get a job.
get_project_statusChanges dataGet the current status of a project by job id. API summary: Update the status of a job.
get_propertyGet one property by target id. Results are paginated. API summary: Get property values for a target.
get_property_values_for_a_playbook_runList properties for a run. Optional filters: updated since. API summary: Get property values for a playbook run.
get_property_values_for_the_systemList properties. Optional filters: since, cursor id, cursor create at or cursor update at. Results are paginated. API summary: Get property values for the system.
get_recapGet one recap by recap id. API summary: Get a specific recap.
get_remote_infoGet one remote info by remote id. API summary: Get remote cluster info by ID for user.
get_remoteclusterGet one remotecluster by remote id. API summary: Get a remote cluster.
get_reportGet one report by report id. API summary: Get a report.
get_roleGet one role by role id. API summary: Get a role.
get_runGet one run by run id. API summary: Get a playbook run.
get_run_statusChanges dataGet the current status of a run by run id. API summary: Update a playbook run's status.
get_scheduled_recapGet one scheduled recap by scheduled recap id. API summary: Get a scheduled recap.
get_schemeGet one scheme by scheme id. API summary: Get a scheme.
get_sharedchannelGet one sharedchannel by team id. Results are paginated. API summary: Get all shared channels for team.
get_teamGet one team by team id. API summary: Get a team.
get_team_get_user_scheduled_postsGet one team by team id. API summary: Gets all scheduled posts for a user for the specified team.
get_team_membersList users for a team. Optional filters: sort or exclude deleted users. Results are paginated. API summary: Get team members.
get_team_members_by_idsChanges dataCreate a new user. Required: items. Search users first to avoid duplicates. API summary: Get team members by ids.
get_team_members_for_a_userList users. API summary: Get team members for a user.
get_team_statusGet the current status of a team by team id. API summary: Get content flagging status for a team.
get_team_userGet one user for a team by user id 2. API summary: Get a thread followed by the user.
get_the_global_data_retention_policyList policies. API summary: Get the global data retention policy.
get_the_granular_data_retention_policiesList policies. Results are paginated. API summary: Get the granular data retention policies.
get_the_jobs_of_the_given_typeGet one project by job type. Results are paginated. API summary: Get the jobs of the given type.
get_the_post_delivery_audit_logging_configurationList shipments. API summary: Get the post delivery audit logging configuration.
get_the_system_content_flagging_configurationList shipments. API summary: Get the system content flagging configuration.
get_total_count_of_users_in_the_systemList users. API summary: Get total count of users in the system.
get_upgrade_to_enterprise_statusGet the current status of a upgrade to enterprise. API summary: Get the current status for the inplace upgrade from Team Edition to Enterprise Edition.
get_userGet a user by `user_id`. Use "me" to get the signed-in user.
get_user_access_tokensList users for a user. Results are paginated. API summary: Get user access tokens.
get_user_can_dmGet one can dm for a user by other user id. API summary: Check if user can DM another user in shared channels context.
get_user_countGet one user. API summary: Gets the full count of users that match the filter.
get_user_preferenceGet one preference for a user by category. API summary: List a user's preferences by category.
get_user_s_sidebar_categoriesList categories. API summary: Get user's sidebar categories.
get_user_statusGet a user's status (online, away, dnd or offline) by `user_id`.
get_user_statuses_by_idChanges dataCreate a new user. Required: items. Search users first to avoid duplicates. API summary: Get user statuses by id.
get_users_by_idsChanges dataCreate a new user. Required: items. Search users first to avoid duplicates. API summary: Get users by ids.
get_users_by_usernamesChanges dataCreate a new user. Required: items. Search users first to avoid duplicates. API summary: Get users by usernames.
list_addressesList addresses. Optional filters: url. API summary: Get redirect location.
list_agentsList agents. API summary: Get available agents.
list_ai_bridgesList ai bridges. API summary: Get AI bridge E2E test helper state.
list_allowedsList alloweds. API summary: Check if the user is allowed to upgrade to Enterprise Edition.
list_app_infosList infos for a app. API summary: Get info on an OAuth app.
list_appsList apps. Results are paginated. API summary: Get OAuth apps.
list_attributesList attributes. API summary: Get the access control attributes governing a team.
list_auditsList audits. Results are paginated. API summary: Get audits.
list_authorizedsList authorizeds. Results are paginated. API summary: Get authorized OAuth apps.
list_autocomplete_commandsList users. API summary: List autocomplete commands.
list_autocomplete_suggestionsList autocomplete suggestions. Optional filters: user input. API summary: List commands' autocomplete data.
list_botsList bots. Optional filters: include deleted or only orphaned. Results are paginated. API summary: Get bots.
list_categoriesList categories. API summary: Get managed category mappings.
list_channel_bookmarksList bookmarks for a channel. Optional filters: bookmarks since. API summary: Get channel bookmarks for Channel.
list_channel_common_teamsList common teams for a channel. API summary: Get common teams for members of a Group Message.
list_channel_member_counts_by_groupsList member counts by groups for a channel. Optional filters: include timezones. API summary: Channel members counts for each group that has atleast one member in the channel.
list_channel_membersList the members of a channel by `channel_id`, with `page` and `limit`.
list_channel_moderationsList moderations for a channel. API summary: Get information about channel's moderation.
list_channel_policiesList channel policies. Results are paginated. API summary: Get the policies which are applied to a user's channels.
list_channel_postsList recent posts in a channel by `channel_id`, with `limit`, `since` (Unix ms) or `before` (a post ID).
list_channel_statsList stats for a channel. API summary: Get channel statistics.
list_channel_timezonesList timezones for a channel. API summary: Get timezones in a channel.
list_channel_unreadsList unreads for a channel. API summary: Get unread messages.
list_channel_users_channel_members_minus_group_membersList users for a channel. Optional filters: group ids. Results are paginated. API summary: Channel members minus group members.
list_channel_viewsList views for a channel. Optional filters: include total count. Results are paginated. API summary: List channel views.
list_channelsList channels. Optional filters: not associated to group, exclude default channels, include deleted, include total count or exclude policy constrained. Results are paginated. API summary: Get a list of all channels.
list_check_cws_connectionsList check cws connections.
list_checklist_autocompletesList checklist autocompletes. Optional filters: channel id. API summary: Get autocomplete data for /playbook check.
list_commandsList commands. Optional filters: team id or custom only. API summary: List commands for a team.
list_customersList customers. API summary: Get client configuration.
list_defaultsList defaults. API summary: Return user's default (generated) profile image.
list_deletedsList deleteds. Results are paginated. API summary: Get deleted channels.
list_document_publicsList publics for a document. Optional filters: h. API summary: Get a public file.
list_document_thumbnailsList thumbnails for a document. API summary: Get a file's thumbnail.
list_documentsList documents for a document. API summary: Get metadata for a file.
list_emojiList emoji. Optional filters: sort. Results are paginated. API summary: Get a list of custom emoji.
list_emoji_imagesList images for a emoji. API summary: Get custom emoji image.
list_environmentsList environments. API summary: Get configuration made through environment variables.
list_exportsList exports. API summary: List export files.
list_first_admin_visitsList first admin visits. API summary: Get if the Plugin Marketplace has been visited by at least an admin.
list_group_channelsList channels for a group. API summary: Get channel syncables for a group.
list_group_propertiesList properties for a group. Optional filters: channel id, team id, target type, target id, since or cursor id. Results are paginated. API summary: Get property fields.
list_group_statsList stats for a group. API summary: Get group stats.
list_group_teamsList teams for a group. API summary: Get team syncables for a group.
list_group_usersList users for a group. Results are paginated. API summary: Get group users.
list_groupsList groups. API summary: Get Custom Profile Attribute property group data.
list_imagesList images. API summary: Get an image by url.
list_importsList imports. API summary: List import files.
list_incomingsList incomings. Optional filters: team id or include total count. Results are paginated. API summary: List incoming webhooks.
list_infosList infos. Optional filters: include deleted. API summary: Get file info for post.
list_installationsList installations. API summary: GET endpoint for Installation information.
list_invoicesList invoices. API summary: Get cloud subscription invoices.
list_knownsList knowns. API summary: Get user IDs of known users.
list_latest_versionsList latest versions. API summary: Get latest public server release information.
list_limit_statusesList limit statuses. API summary: Get recap limit status for the current user.
list_limitsList limits. API summary: Get cloud workspace limits.
list_llmservicesList llmservices. API summary: Get available LLM services.
list_load_metricsList load metrics. API summary: Get license load metric.
list_logsList logs. Optional filters: logs per page. Results are paginated. API summary: Get logs.
list_manifestsList manifests. API summary: Get the session attributes manifest.
list_manualtestsList manualtests. Optional filters: test, uid, username or teamname. API summary: Run manual testing helpers.
list_messagesList messages. Results are paginated. API summary: Get users with invalid emails.
list_metadataList metadata. API summary: Get metadata.
list_modal_dataList modal data. API summary: Get cloud preview modal data.
list_my_channelsList the channels a user belongs to in a team, by `team_id`. Use `user_id` "me" for yourself.
list_my_ipsList my ips. API summary: Get all IP filters.
list_my_teamsList the teams a user belongs to. Use `user_id` "me" for yourself.
list_name_existsList exists for a name. API summary: Check if team exists.
list_oauth_authorization_serversList oauth authorization servers. API summary: Get OAuth 2.0 Authorization Server Metadata.
list_ordersList orders. API summary: Get user's sidebar category order.
list_outgoing_connectionsList outgoing connections. Optional filters: team id. API summary: List all connections.
list_outgoingsList outgoings. Optional filters: team id or channel id. Results are paginated. API summary: List outgoing webhooks.
list_ownersList owners. Optional filters: team id. API summary: Get all owners.
list_page_field_valuesList field values for a page. API summary: Get content flagging property field values for a post.
list_page_reactionsList reactions for a page. API summary: Get a list of reactions to a post.
list_pagesList pages. Optional filters: exclude team or include collapsed threads. API summary: Get team unreads for a user.
list_pages_reveal_postList pages for a page. API summary: Reveal a burn-on-read post.
list_pingsList pings. Optional filters: get server status, device id or use rest semantics. API summary: Check system health.
list_pinned_postsList the pinned posts in a channel by `channel_id`.
list_playbook_autofollowsList autofollows for a playbook. API summary: Get the list of followers' user IDs of a playbook.
list_playbook_conditionsList conditions for a playbook. Results are paginated. API summary: List playbook conditions.
list_playbook_propertiesList properties for a playbook. Optional filters: updated since. API summary: Get property fields for a playbook.
list_playbooksList playbooks. Optional filters: team id, sort, direction or with archived. Results are paginated. API summary: List all playbooks.
list_pluginsList plugins. API summary: Get plugins.
list_policiesList policies. API summary: Get the access control policy for a team.
list_policies_countsList policies counts. API summary: Get the number of granular data retention policies.
list_policy_channelsList channels for a policy. Results are paginated. API summary: Get the channels for a granular data retention policy.
list_policy_teamsList teams for a policy. Results are paginated. API summary: Get the teams for a granular data retention policy.
list_prevsList prevs. API summary: Get last trial license used.
list_privatesList privates. Results are paginated. API summary: Get private channels.
list_productsList products. API summary: Get cloud products.
list_projectsList projects. Optional filters: job type or status. Results are paginated. API summary: Get the jobs.
list_propertiesList properties. API summary: List all the Custom Profile Attributes fields.
list_public_channelsList the public channels in a team by `team_id`, with `page` and `limit`.
list_recapsList recaps. Results are paginated. API summary: Get current user's recaps.
list_recommendedList recommended. API summary: Get recommended public channels for the current user.
list_remotecluster_sharedchannelremotesList sharedchannelremotes for a remotecluster. Optional filters: include unconfirmed, exclude confirmed, exclude home, exclude remote or include deleted. Results are paginated. API summary: Get shared channel remotes by remote cluster.
list_remoteclustersList remoteclusters. Optional filters: exclude offline, in channel, not in channel, only confirmed, only plugins or exclude plugins. Results are paginated. API summary: Get a list of remote clusters.
list_reportsList reports. Results are paginated. API summary: Get reports.
list_rolesList roles. API summary: Get a list of all the roles.
list_run_conditionsList conditions for a run. Results are paginated. API summary: List run conditions.
list_run_metadataList metadata for a run. API summary: Get playbook run metadata.
list_run_propertiesList properties for a run. Optional filters: updated since. API summary: Get property fields for a playbook run.
list_saved_postsList the posts a user has saved (flagged). Use `user_id` "me"; optionally narrow by `team_id` or `channel_id`.
list_scheduled_recapsList scheduled recaps. Results are paginated. API summary: Get current user's scheduled recaps.
list_scheme_channelsList channels for a scheme. Results are paginated. API summary: Get a page of channels which use this scheme.
list_scheme_teamsList teams for a scheme. Results are paginated. API summary: Get a page of teams which use this scheme.
list_schemesList schemes. Optional filters: scope. Results are paginated. API summary: Get the schemes.
list_server_busiesList server busies. API summary: Get server busy expiry time.
list_serversList servers. API summary: Gets the server limits for the server.
list_sharedchannel_remotesList remotes for a sharedchannel. API summary: Get remote clusters for a shared channel.
list_shipmentsList shipments. Optional filters: remove masked or remove defaults. API summary: Get configuration.
list_signup_availablesList signup availables. API summary: Check hosted signup availability.
list_statusesList statuses. API summary: Get plugins status.
list_storagesList storages. API summary: Get the total file storage usage for the instance in bytes.
list_subscriptionsList subscriptions. API summary: Get cloud subscription.
list_support_packetsList support packets. Optional filters: basic server logs or plugin packets. API summary: Download a zip file which contains helpful and useful information for troubleshooting your mattermost instance.
list_team_draftsList drafts for a team. API summary: Get synced drafts for a team.
list_team_imagesList images for a team. API summary: Get the team icon.
list_team_policiesList team policies. Results are paginated. API summary: Get the policies which are applied to a user's teams.
list_team_statsList stats for a team. API summary: Get a team stats.
list_team_unreadsList unreads for a team. API summary: Get unreads for a team.
list_team_usersList users for a team. Optional filters: since, deleted, extended, totals only or threads only. Results are paginated. API summary: Get all threads that user is following.
list_team_users_team_members_minus_group_membersList users for a team. Optional filters: group ids. Results are paginated. API summary: Team members minus group members.
list_teamsList teams. Optional filters: include total count or exclude policy constrained. Results are paginated. API summary: Get teams.
list_terms_of_servicesList terms of services. API summary: Get latest terms of service.
list_timezonesList timezones. API summary: Retrieve a list of supported timezones.
list_user_auditsList audits for a user. API summary: Get user's audits.
list_user_channelsList channels for a user. Optional filters: last delete at or include deleted. API summary: Get all channels from all teams.
list_user_custom_profile_attributesList custom profile attributes for a user. API summary: List Custom Profile Attribute values.
list_user_documentsList documents for a user. API summary: Get uploads for a user.
list_user_groupsList groups for a user. API summary: Get groups for a userId.
list_user_imagesList images for a user. API summary: Get user's profile image.
list_user_preferencesList preferences for a user. API summary: Get the user's preferences.
list_usersList users. Optional filters: in team, not in team, in channel, not in channel, in group or group constrained. Results are paginated. API summary: Get users.
list_users_get_channel_members_with_team_data_for_userList users for a user. Results are paginated. API summary: Get all channel members from all teams for a user.
list_users_get_user_access_tokensList users. Results are paginated. API summary: Get user access tokens.
list_users_get_user_terms_of_serviceList users for a user. API summary: Fetches user's latest terms of service action if the latest action was for acceptance.
list_versionsList versions. API summary: Get applied database schema migrations.
list_view_pagesList pages for a view. Optional filters: property group. Results are paginated. API summary: Get posts for a view.
list_webappsList webapps. API summary: Get webapp plugins.
list_websocketsList websockets. Optional filters: connection id, sequence number, posted ack or disconnect err code. API summary: Open a WebSocket connection.
open_direct_messageChanges dataOpen (or find) a direct message channel between two users; `items` is the two user IDs. Returns the channel to post in.
open_group_messageChanges dataOpen (or find) a group message channel for 3 to 8 users; `items` is their user IDs.
pin_postChanges dataPin a post to its channel by `post_id`.
remove_private_keyMoves moneyPermanently delete a private. Financial or irreversible action; may require approval. API summary: Remove private key.
remove_public_certificateMoves moneyPermanently delete a public. Financial or irreversible action; may require approval. API summary: Remove public certificate.
remove_reactionDeletesRemove an emoji reaction (`emoji_name`) from a post (`post_id`) for a user (`user_id`).
restore_botChanges dataEnable a bot (bot user id).
restore_channelChanges dataRestore a channel (channel id).
restore_groupChanges dataRestore a group (group id). API summary: Restore a previously deleted group.
restore_pageChanges dataRestore a page (page version id). API summary: Restores a past version of a post.
restore_pluginChanges dataEnable a plugin (plugin id). API summary: Enable plugin.
restore_teamChanges dataRestore a team (team id).
restore_userDeletesEnable a user. Destructive action; may require approval. API summary: Enable personal access token.
search_access_control_policiesChanges dataSearch access control policies. Use this to find existing access control policies before creating a new access control policy.
search_actionsChanges dataSearch actions. Use this to find existing actions before creating a new action. API summary: Search allowed actions for the current user (render-time decision).
search_channel_groupsSearch groups for a channel by filter allow reference. Use this to find existing groups before creating a new group. Results are paginated. API summary: Get channel groups.
search_channelsChanges dataSearch public channels in a team (`team_id`) by name with `term`.
search_channels_2Changes dataSearch channels by system console. Use this to find existing channels before creating a new channel. API summary: Search all private and open type channels across all teams.
search_channels_autocompleteSearch channels by name. Use this to find existing channels before creating a new channel. API summary: Autocomplete channels for search.
search_channels_for_an_access_control_policyChanges dataSearch channels. Use this to find existing channels before creating a new channel. API summary: Search channels for an access control policy.
search_channels_search_channels_for_retention_policyChanges dataSearch channels. Use this to find existing channels before creating a new channel. API summary: Search for the channels in a granular data retention policy.
search_dialogsChanges dataSearch dialogs. Use this to find existing dialogs before creating a new dialog. API summary: Lookup dialog elements.
search_documentsChanges dataSearch documents. Use this to find existing documents before creating a new document. API summary: Search files in a team.
search_documents_searchChanges dataSearch documents. Use this to find existing documents before creating a new document. API summary: Search files across the teams of the current user.
search_emojiChanges dataSearch emoji. Use this to find existing emoji before creating a new emoji. API summary: Search custom emoji.
search_groupsChanges dataSearch groups. Use this to find existing groups before creating a new group. API summary: Search Group Channels.
search_groups_get_ldap_groupsSearch groups by q. Use this to find existing groups before creating a new group. Results are paginated. API summary: Returns a list of LDAP groups.
search_ip_filteringsSearch ip filterings. Use this to find existing ip filterings before creating a new ip filtering. API summary: Get all IP filters.
search_logsChanges dataSearch logs by logs per page. Use this to find existing logs before creating a new log. API summary: Query server logs with filters.
search_marketplacesSearch marketplaces by filter, server version or local only. Use this to find existing marketplaces before creating a new marketplace. Results are paginated. API summary: Gets all the marketplace plugins.
search_oldsSearch olds by name or team id. Use this to find existing olds before creating a new old. API summary: Get analytics.
search_pagesChanges dataSearch pages. Use this to find existing pages before creating a new page. API summary: Search posts across all teams.
search_postsChanges dataSearch posts in a team (`team_id`) with `terms`; set `is_or_search` to match any term instead of all.
search_propertiesChanges dataSearch properties. Use this to find existing properties before creating a new property. API summary: Search property fields across multiple object types.
search_reviewersSearch reviewers by term. Use this to find existing reviewers before creating a new reviewer. API summary: Search content reviewers in a team.
search_runsSearch runs by team id, sort, direction, statuses, owner user id or participant id. Use this to find existing runs before creating a new run. Results are paginated. API summary: List all playbook runs.
search_team_groupsSearch groups for a team by filter allow reference, include member count, include timezones, include total count, include archived or filter archived. Use this to find existing groups before creating a new group. Results are paginated. API summary: Get team groups.
search_team_groups_by_channelsSearch groups by channels for a team by filter allow reference or paginate. Use this to find existing groups by channels before creating a new groups by channel. Results are paginated. API summary: Get team groups by channels.
search_teamsChanges dataSearch teams. Use this to find existing teams before creating a new team.
search_teams_searchChanges dataSearch teams. Use this to find existing teams before creating a new team. API summary: Search for the teams in a granular data retention policy.
search_tokensDeletesSearch users. Use this to find existing users before creating a new user. Destructive action; may require approval. API summary: Search tokens.
search_usersChanges dataSearch users by name, username or email with `term`, optionally within a team or channel.
search_users_autocomplete_channels_for_teamSearch users by name. Use this to find existing users before creating a new user. API summary: Autocomplete channels.
search_users_autocomplete_emojiSearch users by name. Use this to find existing users before creating a new user. API summary: Autocomplete custom emoji.
search_users_autocomplete_usersSearch users by team id, channel id or name. Use this to find existing users before creating a new user. Results are paginated. API summary: Autocomplete users.
search_users_get_total_users_stats_filteredSearch users by in team, in channel, include deleted, include bots, roles or channel roles. Use this to find existing users before creating a new user. API summary: Get total count of users in the system matching the specified filters.
search_users_get_users_for_reportingSearch users by sort column, direction, sort direction, from column value, from id or date range. Use this to find existing users before creating a new user. Results are paginated. API summary: Get a list of paged and sorted users for admin reporting purposes.
send_a_test_notificationChanges dataCreate a new test. API summary: Send a test notification.
send_inviteVisible to othersEmail a invite (team id). Has effects visible outside this system. API summary: Invite users to the team by email.
send_invite_emailMoves moneyEmail a invite. Financial or irreversible action; may require approval. API summary: Invalidate active email invitations.
send_invite_guestVisible to othersEmail a invite guest (team id). Has effects visible outside this system. API summary: Invite guests to the team by email.
send_resetDeletesSend a reset. Destructive action; may require approval. API summary: Send password reset email.
send_user_adminDeletesNotify a user. Destructive action; may require approval. API summary: Save notify-admin intent.
send_user_propsVisible to othersNotify a user (user id). Has effects visible outside this system. API summary: Update channel notifications.
send_verifyVisible to othersSend a verify. Has effects visible outside this system. API summary: Send verification email.
submit_access_control_policyDeletesActivate a access control policy. Destructive action; may require approval. API summary: Activate or deactivate access control policies.
submit_cel_requesterVisible to othersValidate a cel. Has effects visible outside this system. API summary: Validate if the current user matches a CEL expression.
submit_client_perfVisible to othersSubmit a client perf. Has effects visible outside this system. API summary: Report client performance metrics.
submit_cloud_business_emailVisible to othersValidate a cloud. Has effects visible outside this system. API summary: Validate business email.
submit_cloud_workspace_business_emailVisible to othersValidate a cloud. Has effects visible outside this system. API summary: Validate workspace business email.
submit_dialogVisible to othersSubmit a dialog. Has effects visible outside this system.
submit_ldapVisible to othersSync a ldap. Has effects visible outside this system. API summary: Sync with LDAP.
submit_messageVisible to othersVerify a message. Has effects visible outside this system. API summary: Verify user email.
submit_onboardingVisible to othersComplete a onboarding. Has effects visible outside this system. API summary: Complete first admin onboarding.
submit_outgoing_connectionVisible to othersValidate a outgoing connection. Has effects visible outside this system. API summary: Validate a connection configuration.
submit_recapVisible to othersMark viewed a recap. Has effects visible outside this system. API summary: Mark all of the authenticated user's finished recaps as viewed.
submit_typingVisible to othersSubmit a typing (user id). Has effects visible outside this system. API summary: Publish a user typing websocket event.
submit_userVisible to othersMark read a user (user id). Has effects visible outside this system. API summary: Mark multiple channels as read.
update_a_scheduled_postChanges dataUpdate an existing page identified by scheduled post id. API summary: Update a scheduled post.
update_a_team_member_rolesMoves moneyUpdate an existing role identified by user id. Financial or irreversible action; may require approval. API summary: Update a team member roles.
update_a_user_s_authentication_methodVisible to othersUpdate an existing user identified by user id. Has effects visible outside this system. API summary: Update a user's authentication method.
update_access_control_policiesVisible to othersUpdate an existing access control policy. Has effects visible outside this system. API summary: Create an access control policy.
update_addressesVisible to othersUpdate an existing address. Has effects visible outside this system. API summary: Update cloud customer address.
update_ai_bridgesVisible to othersUpdate an existing ai bridge. Has effects visible outside this system. API summary: Configure AI bridge E2E test helper.
update_appChanges dataUpdate an existing app identified by app id. API summary: Update an OAuth app.
update_botChanges dataUpdate an existing bot identified by bot user id. API summary: Patch a bot.
update_categoriesVisible to othersUpdate an existing category identified by team id. Has effects visible outside this system. API summary: Update user's sidebar categories.
update_categoryChanges dataUpdate an existing category identified by category id. API summary: Update sidebar category.
update_channelVisible to othersUpdate a channel by `channel_id`: display name, header or purpose. Only the fields you pass change.
update_channel_2Changes dataUpdate an existing channel identified by channel id. API summary: Update a channel.
update_channel_bookmarkChanges dataUpdate an existing bookmark identified by bookmark id. Only the fields you pass are changed. API summary: Update channel bookmark.
update_channel_privaciesVisible to othersUpdate an existing privacy identified by channel id. Has effects visible outside this system. API summary: Update channel's privacy.
update_channel_schemesVisible to othersUpdate an existing scheme identified by channel id. Has effects visible outside this system. API summary: Set a channel's scheme.
update_channel_usersVisible to othersUpdate an existing user identified by channel id. Has effects visible outside this system. API summary: Set channel members.
update_channel_viewChanges dataUpdate an existing view identified by view id. Only the fields you pass are changed. API summary: Update a channel view.
update_checklist_productChanges dataUpdate an existing product identified by item. API summary: Update an item of a playbook run's checklist.
update_checklist_reordersVisible to othersUpdate an existing reorder identified by checklist. Has effects visible outside this system. API summary: Reorder an item in a playbook run's checklist.
update_commandChanges dataUpdate an existing command identified by command id. API summary: Update a command.
update_command_movesVisible to othersUpdate an existing move identified by command id. Has effects visible outside this system. API summary: Move a command.
update_command_regen_tokensMoves moneyUpdate an existing regen token identified by command id. Financial or irreversible action; may require approval. API summary: Generate a new token.
update_customersVisible to othersUpdate an existing customer. Has effects visible outside this system. API summary: Update cloud customer.
update_customsVisible to othersUpdate an existing custom identified by user id. Has effects visible outside this system. API summary: Update user custom status.
update_group_patchesVisible to othersUpdate an existing patch identified by group id. Has effects visible outside this system. API summary: Patch a group.
update_incomingDeletesUpdate an existing incoming identified by hook id. Destructive action; may require approval. API summary: Update an incoming webhook.
update_item_assigneesVisible to othersUpdate an existing assignee identified by item. Has effects visible outside this system. API summary: Update the assignee of an item.
update_item_runsVisible to othersUpdate an existing run identified by item. Has effects visible outside this system. API summary: Run an item's slash command.
update_item_statesVisible to othersUpdate an existing state identified by item. Has effects visible outside this system. API summary: Update the state of an item.
update_ordersVisible to othersUpdate an existing order identified by team id. Has effects visible outside this system. API summary: Update user's sidebar category order.
update_outgoingDeletesUpdate an existing outgoing identified by hook id. Destructive action; may require approval. API summary: Update an outgoing webhook.
update_outgoing_connectionChanges dataUpdate an existing outgoing connection identified by outgoing oauth connection id. API summary: Update a connection.
update_pageChanges dataUpdate an existing page identified by page id. API summary: Update a post.
update_page_actionChanges dataUpdate an existing action identified by action id. API summary: Perform a post action.
update_page_assignChanges dataUpdate an existing assign identified by content reviewer id. API summary: Assign a content reviewer to a flagged post.
update_page_historyChanges dataUpdate an existing page identified by post id. API summary: Get post edit history.
update_page_keepsVisible to othersUpdate an existing keep identified by post id. Has effects visible outside this system. API summary: Keep a flagged post.
update_page_unreadChanges dataUpdate an existing page identified by post id. API summary: Mark as unread from a post.
update_patchesVisible to othersUpdate an existing patch identified by channel id. Has effects visible outside this system. API summary: Update a channel's moderation settings.
update_playbookChanges dataUpdate an existing playbook identified by playbook id. API summary: Update a playbook.
update_playbook_conditionChanges dataUpdate an existing condition identified by condition id. API summary: Update a playbook condition.
update_playbook_propertyChanges dataUpdate an existing property identified by field id. API summary: Update a property field for a playbook.
update_policyChanges dataUpdate an existing policy identified by policy id. Only the fields you pass are changed. API summary: Patch a granular data retention policy.
update_propertiesVisible to othersUpdate an existing property. Only the fields you pass are changed. Has effects visible outside this system. API summary: Patch Custom Profile Attribute values.
update_propertyChanges dataUpdate an existing property identified by property id. Only the fields you pass are changed. API summary: Patch a Custom Profile Attribute field.
update_property_field_propertiesVisible to othersUpdate an existing property identified by field id. Has effects visible outside this system. API summary: Set a property value for a playbook run.
update_property_values_for_a_targetChanges dataUpdate an existing property identified by target id. Only the fields you pass are changed. API summary: Update property values for a target.
update_readsVisible to othersUpdate an existing read identified by team id. Has effects visible outside this system. API summary: Mark all threads that user is following as read.
update_remoteclusterChanges dataUpdate an existing remotecluster identified by remote id. Only the fields you pass are changed. API summary: Patch a remote cluster.
update_role_patchesMoves moneyUpdate an existing patch identified by role id. Financial or irreversible action; may require approval. API summary: Patch a role.
update_runChanges dataUpdate an existing run identified by run id. Only the fields you pass are changed. API summary: Update a playbook run.
update_run_endsVisible to othersUpdate an existing end identified by run id. Has effects visible outside this system. API summary: End a playbook run.
update_run_finishesVisible to othersUpdate an existing finish identified by run id. Has effects visible outside this system. API summary: Finish a playbook.
update_run_restartsVisible to othersUpdate an existing restart identified by run id. Has effects visible outside this system. API summary: Restart a playbook run.
update_scheduled_recapChanges dataUpdate an existing scheduled recap identified by scheduled recap id. API summary: Update a scheduled recap.
update_scheme_patchesVisible to othersUpdate an existing patch identified by scheme id. Has effects visible outside this system. API summary: Patch a scheme.
update_shipmentsVisible to othersUpdate an existing shipment. Has effects visible outside this system. API summary: Update configuration.
update_teamChanges dataUpdate an existing team identified by team id. API summary: Update a team.
update_team_patchesVisible to othersUpdate an existing patch identified by team id. Has effects visible outside this system. API summary: Patch a team.
update_team_privaciesVisible to othersUpdate an existing privacy identified by team id. Has effects visible outside this system. API summary: Update teams's privacy.
update_team_readsVisible to othersUpdate an existing read identified by team id. Has effects visible outside this system. API summary: Mark all channels and threads in a team as read.
update_team_schemesVisible to othersUpdate an existing scheme identified by team id. Has effects visible outside this system. API summary: Set a team's scheme.
update_thread_followingsVisible to othersUpdate an existing following identified by thread id. Has effects visible outside this system. API summary: Start following a thread.
update_thread_readChanges dataUpdate an existing read identified by timestamp. API summary: Mark a thread that user is following read state to the timestamp.
update_thread_set_unreadChanges dataUpdate an existing set unread identified by post id. API summary: Mark a thread that user is following as unread based on a post id.
update_userChanges dataUpdate an existing user identified by user id. API summary: Update a user.
update_user_activesVisible to othersUpdate an existing active identified by user id. Has effects visible outside this system. API summary: Activate or deactivate a user.
update_user_autotranslationsVisible to othersUpdate an existing autotranslation identified by user id. Has effects visible outside this system. API summary: Update channel member autotranslation setting.
update_user_custom_profile_attributesVisible to othersUpdate an existing custom profile attribute identified by user id. Only the fields you pass are changed. Has effects visible outside this system. API summary: Update custom profile attribute values for a user.
update_user_mfasVisible to othersUpdate an existing mfa identified by user id. Has effects visible outside this system. API summary: Update a user's MFA.
update_user_passwordsMoves moneyUpdate an existing password identified by user id. Financial or irreversible action; may require approval. API summary: Update a user's password.
update_user_preferencesVisible to othersUpdate an existing preference identified by user id. Has effects visible outside this system. API summary: Save the user's preferences.
update_user_rolesMoves moneyUpdate an existing role identified by user id. Financial or irreversible action; may require approval. API summary: Update a user's roles.
update_user_scheme_rolesMoves moneyUpdate an existing scheme role identified by user id. Financial or irreversible action; may require approval. API summary: Update the scheme-derived roles of a team member.
update_user_statusChanges dataGet the current status of a user by user id. API summary: Update user status.
update_usersVisible to othersUpdate an existing user identified by user id. Has effects visible outside this system. API summary: Patch a user.
update_viewsVisible to othersUpdate an existing view. Has effects visible outside this system. API summary: Update notices as 'viewed'.
upload_documentChanges dataUpload a document. API summary: Upload a file.
upload_document_upload_dataChanges dataUpload a document (document id). API summary: Perform a file upload.
upload_file_data_for_a_remote_upload_sessionChanges dataUpload a document (document id). API summary: Upload file data for a remote upload session.

Set up in three steps

1
Pick the app
Create a free HeyMyApps account and choose Mattermost from the app list.
2
Paste your key
Paste your Mattermost server address without a trailing slash, and a personal access token. An admin must first enable personal access tokens in System Console › Integrations › Integration Management. Then open your avatar › Profile › Security › Personal Access Tokens, click Create Token, add a description and copy the access token. It is shown only once.
3
Add the link to your AI
You get a personal MCP link. Add it to Claude, ChatGPT or Cursor:
1. Click your name, then Settings › Connectors › Add custom connector.
2. Paste your link as the Remote MCP server URL.
3. Switch it on from the + menu in a chat.

Questions

What can the AI do in Mattermost?

It can read teams, channels, channel members, posts, threads, pinned and saved posts and users, and search posts, channels and users. It can post messages and thread replies, edit and delete posts, pin posts, add and remove reactions, create and update channels, add members and open direct and group messages.

Does the AI see my Mattermost credentials?

No. Your Mattermost credentials are encrypted at rest and never shown to the AI. After you save them, they are not shown again, not even to you. The AI only sees the results of the tools it calls.

Can I control what the AI is allowed to do?

Yes. You choose which tools are switched on, so you can start read-only. Editing posts and updating channels can require your approval before they run, and so can deleting a post, which cannot be undone. Every tool call is logged.

Does it work with ChatGPT?

Yes. In ChatGPT go to Settings › Apps & Connectors › Advanced and turn on Developer mode, then add your HeyMyApps link. Developer mode needs a paid ChatGPT plan: Plus, Pro, Business or Enterprise. The same link also works in Claude (Settings › Connectors › Add custom connector), Cursor and other MCP clients.

What does it cost?

HeyMyApps has a free plan with no credit card required. Paid plans bill per completed task. You also need your own Mattermost account.

Why does an admin need to enable personal access tokens?

Mattermost only lets users create personal access tokens after a system admin turns them on in System Console › Integrations › Integration Management. The token acts as the user who created it, so the AI can reach the teams and channels that user can.