Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt

Use this file to discover all available pages before exploring further.

Get a list of users with optional filtering. Required Permissions: manage_system or an active session and membership in the team or channel.
External DocumentationTo learn more, visit the Mattermost documentation.

​
Basic Parameters

ParameterDescription
Channel IDThe ID of a channel to filter users in a specific channel.
Filter Active UsersSelect to return active or inactive users only.
Group IDThe ID of a group to filter users by. Requires manage_system permission.
PageThe page number to retrieve, starting at 0.
Per PageThe maximum number of items to retrieve per page.
Return All PagesAutomatically fetch all resources, page by page.
SortThe field to sort users by.

To sort by last_activity_at or create_at a Team ID is required. To sort by status a Channel ID is required. To sort by display_name a Group ID is required.

For more information, see sort parameter explanation
Team IDThe ID of a team to filter users in a specific team.

​
Advanced Parameters

ParameterDescription
ABAC Match OnlySelect to restrict results to users whose attributes satisfy the channel’s Attribute-Based Access Control (ABAC) membership policy.
Channel RolesA comma-separated list of channel roles to filter users by. Must be used with the In Channel parameter.
Group ConstrainedSelect to return only users allowed to join the channel or team based on group constraints. Use with Not In Channel or Not In Team.
Not In ChannelThe ID of a channel to exclude members from the results. Must be used with the In Channel parameter.
Not In TeamThe ID of a team to exclude users from. Cannot be used with the In Team parameter.
RoleThe role to filter results by.
RolesA comma-separated list of system roles to filter users by. Returns users that match any of the specified roles.

For example: system_admin,system_user returns users that are either system admins or system users.
Team RolesA comma-separated list of team roles to filter users by. Must be used with the In Team parameter.

For example: team_user returns users that are only team users and not admins or guests.
Without TeamSelect to return only users that are not on any team. Takes precedence over In Team, In Channel, and Not In Channel.

​
Example Output

[
	{
		"id": "string",
		"create_at": 0,
		"update_at": 0,
		"delete_at": 0,
		"username": "string",
		"first_name": "string",
		"last_name": "string",
		"nickname": "string",
		"email": "string",
		"email_verified": true,
		"auth_service": "string",
		"roles": "string",
		"locale": "string",
		"notify_props": {
			"email": "string",
			"push": "string",
			"desktop": "string",
			"desktop_sound": "string",
			"mention_keys": "string",
			"channel": "string",
			"first_name": "string",
			"auto_responder_message": "string",
			"push_threads": "string",
			"comments": "string",
			"desktop_threads": "string",
			"email_threads": "string"
		},
		"props": {},
		"last_password_update": 0,
		"last_picture_update": 0,
		"failed_attempts": 0,
		"mfa_active": true,
		"timezone": {
			"useAutomaticTimezone": "string",
			"manualTimezone": "string",
			"automaticTimezone": "string"
		},
		"terms_of_service_id": "string",
		"terms_of_service_create_at": 0
	}
]

​
Workflow Library Example

List Users with Mattermost and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop