Mattermost
Information and details management platform
Actions (48)
Users · 28
- Autocomplete usersGET /api/v4/users/autocomplete
Return a list of users suitable for autocomplete filtering.
documented - Create userPOST /api/v4/users
Create a new user account on the Mattermost server.
documented - Delete userDELETE /api/v4/users/{user_id}
Deactivate or permanently delete a user (depends on server config).
documented - Delete user recent custom statusPOST /api/v4/users/{user_id}/status/custom/recent/delete
Delete a recent custom status for the user.
documented - Get filtered user statsGET /api/v4/users/stats/filtered
Return a count of users matching provided filters (e.g., team, channel, roles).
documented - Get known usersGET /api/v4/users/known
Return IDs of users with direct relationships to the requester.
documented - Get total users statsGET /api/v4/users/stats
Return the total count of users in the system.
documented - Get userGET /api/v4/users/{user_id}
Retrieve a single user object by ID (or 'me').
documented - Get user profile imageGET /api/v4/users/{user_id}/image
Retrieve a user’s profile image.
documented - Get user statusGET /api/v4/users/{user_id}/status
Fetch user's current presence status.
documented - Get user statuses by idsPOST /api/v4/users/status/ids
Return statuses for a list of user IDs.
documented - Get users by group channelsPOST /api/v4/users/group_channels
Return users that are members of specified group channels.
documented - Get users by idsPOST /api/v4/users/ids
Return a list of users for a provided set of user IDs.
documented - Get users by usernamesPOST /api/v4/users/usernames
Return users matching a list of usernames.
documented - List usersGET /api/v4/users
Return a paginated list of users with optional filters.
documented - Login by CWS tokenPOST /api/v4/users/login/cws
Auto-login to Mattermost via Customer Web Server (CWS) token.
documented - Login userPOST /api/v4/users/login
Authenticate a user and establish a session by returning a token.
documented - Logout userPOST /api/v4/users/logout
End the current session for the authenticated user.
documented - Patch userPUT /api/v4/users/{user_id}/patch
Partially update a user with only the provided fields.
documented - Post user recent custom statusPOST /api/v4/users/{user_id}/status/custom/recent
Save a recent custom status for the user.
documented - Search usersPOST /api/v4/users/search
Search for users based on a term and optional filters.
documented - Set user profile imagePOST /api/v4/users/{user_id}/image
Upload/set a user's profile image.
documented - Unset user custom statusDELETE /api/v4/users/{user_id}/status/custom
Remove the user’s custom status.
documented - Update userPUT /api/v4/users/{user_id}
Update user fields for the specified user.
documented - Update user active statePUT /api/v4/users/{user_id}/active
Activate or deactivate the user account.
documented - Update user custom statusPUT /api/v4/users/{user_id}/status/custom
Update a user’s custom status (emoji/text).
documented - Update user rolesPUT /api/v4/users/{user_id}/roles
Publish new system roles for the specified user.
documented - Update user statusPUT /api/v4/users/{user_id}/status
Set the user’s status (online/away/offline/dnd).
documented
OAuth · 8
- Create OAuth appPOST /api/v4/oauth/apps
Register a new OAuth 2.0 client application.
documented - Delete OAuth appDELETE /api/v4/oauth/apps/{app_id}
Unregister an OAuth 2.0 client application.
documented - Get OAuth appGET /api/v4/oauth/apps/{app_id}
Retrieve a specific OAuth app.
documented - Get OAuth app infoGET /api/v4/oauth/apps/{app_id}/info
Get public information about an OAuth app.
documented - Get authorized OAuth apps (user)GET /api/v4/users/{user_id}/oauth/apps/authorized
List OAuth apps authorized to access a user’s account.
documented - List OAuth appsGET /api/v4/oauth/apps
List registered OAuth 2.0 client applications.
documented - Regenerate OAuth app secretPOST /api/v4/oauth/apps/{app_id}/regen_secret
Generate a new client secret for the OAuth app.
documented - Update OAuth appPUT /api/v4/oauth/apps/{app_id}
Update an OAuth 2.0 client application.
documented
Brand · 6
- Delete brand imageDELETE /api/v4/brand/image
Remove the currently uploaded brand image.
documented - Delete brand imageDELETE /api/v4/brand/image
Remove the current brand image.
documented - Get brand imageGET /api/v4/brand/image
Return the current brand image.
documented - Get brand imageGET /api/v4/brand/image
Retrieve the currently uploaded brand image.
documented - Upload brand imagePOST /api/v4/brand/image
Upload a brand image for branding purposes.
documented - Upload brand imagePOST /api/v4/brand/image
Upload a brand image for the organization.
documented
System · 6
- Get client configurationGET /api/v4/config/client
Get client-relevant configuration subset.
documented - Get configurationGET /api/v4/config
Retrieve server configuration.
documented - Get supported timezonesGET /api/v4/system/timezones
Return a list of timezones supported by the server.
documented - Patch configurationPUT /api/v4/config
Submit configuration updates to the server.
documented - Reload configurationPOST /api/v4/config/reload
Reload the server configuration from disk.
documented - System pingGET /api/v4/system/ping
Check system health.
documented