Integrations
Retool
APIs
List Groups per User

List Groups per User

This method lists all groups a user is a member of, along with the last time a user was active in Retool. It helps administrators understand which groups users belong to and their activity levels.

For more information on the API for listing groups per user, see List users (opens in a new tab) and List groups (opens in a new tab).

Required Permission Scopes:

  • Users > Read
  • Groups > Read

SDK Import:

from admyral.actions import list_groups_per_user

Arguments

Argument NameDescriptionRequired

Returns

A JSON object containing a mapping from users to another JSON object storing the names of the groups a user belongs to as well as the last active date.

Schema:

{
	user_email: {
		"last_active": last_active_date,
		"groups": list_of_group_names
	}
}

Required Secrets

Secret PlaceholderDescription
RETOOL_SECRETRetool secret. See Retool setup

SDK Example

groups_per_user = list_groups_per_user(
	secrets={"RETOOL_SECRET": "my_stored_retool_secret"}
)