List All Teams

Get a list of all teams.

Note: For regular users, this will return open teams only. To get all the teams manage_system permission is required.

External Documentation

To learn more, visit the Mattermost documentation.

​

Parameters

Parameter	Description
Exclude Policy Constrained	Select to exclude teams that are part of a data retention policy. Requires the sysconsole_read_compliance permission.
Page	The page number to retrieve, starting at 0.
Per Page	The maximum number of items to retrieve per page.
Return All Pages	Automatically fetch all resources, page by page.

​

Example Output

{
	"teams": [
		{
			"id": "string",
			"create_at": 0,
			"update_at": 0,
			"delete_at": 0,
			"display_name": "string",
			"name": "string",
			"description": "string",
			"email": "string",
			"type": "string",
			"company_name": "string",
			"allowed_domains": "string",
			"invite_id": "string",
			"allow_open_invite": true,
			"scheme_id": "string",
			"group_constrained": true,
			"policy_id": "string",
			"cloud_limits_archived": true
		}
	],
	"total_count": 0
}