Skip to main content
List and query groups. You can search for groups by combining various query parameters.
External DocumentationTo learn more, visit the Authentik documentation.

​
Basic Parameters

ParameterDescription
Group NameQuery by the name of the group.
Members By UsernameQuery by a comma separated list of the group’s member usernames. Can be obtained by the List Users action.

​
Advanced Parameters

ParameterDescription
AttributesQuery by the additional attributes.
Include UsersInclude the group’s users in the response.
Is SuperuserIs the group designated as a superuser group.
Members By IDQuery by a comma separated list of the group’s member IDs. Can be obtained by the List Users action.
Order ByWhich field to use when ordering the results.
Page NumberThe page number being requested.
Page SizeNumber of results to return per page.
SearchA search term.

​
Example Output

{
	"pagination": {
		"next": 0,
		"previous": 1,
		"count": 4,
		"current": 1,
		"total_pages": 0,
		"start_index": 2,
		"end_index": 5
	},
	"results": [
		{
			"pk": "<string>",
			"num_pk": 32226,
			"name": "<string>",
			"is_superuser": false,
			"parent": null,
			"parent_name": null,
			"users": [],
			"users_obj": [],
			"attributes": {},
			"roles": [],
			"roles_obj": []
		},
		{
			"pk": "<string>",
			"num_pk": 8839,
			"name": "<string>",
			"is_superuser": true,
			"parent": null,
			"parent_name": null,
			"users": [
				11
			],
			"users_obj": [
				{
					"pk": 12,
					"username": "<string>",
					"name": "<string>",
					"is_active": true,
					"last_login": "<string>",
					"email": "<string>",
					"attributes": {},
					"uid": "<string>"
				}
			],
			"attributes": {},
			"roles": [],
			"roles_obj": []
		}
	]
}

​
Workflow Library Example

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