Skip to main content
Retrieve a list of user groups in the organization. Required scope for using this action:
  • Obtain user groups information
External DocumentationTo learn more, visit the Lark documentation.

​
Parameters

ParameterDescription
Page SizeThe number of groups to return per page (1-200).
Page TokenA token used for pagination. This value can be obtained from the page_token property from a previous response.
Return All PagesAutomatically fetch all resources, page by page.

​
Example Output

{
	"code": 0,
	"msg": "success",
	"data": {
		"grouplist": [
			{
				"id": "g193821",
				"name": "IT outsourcing group",
				"description": "IT outsourcing group. Fine-grained permission control is required for this group.",
				"member_user_count": 2,
				"member_department_count": 0
			}
		],
		"page_token": "AQD9/Rn9556539ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JDTJJDDPw=",
		"has_more": true
	}
}

​
Workflow Library Example

List Groups with Lark and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop
⌘I