List Groups - BlinkOps Documentation

List and query groups. You can search for groups by combining various query parameters. Note: When using the Return All Pages parameter, the size of each retrieved page can be controlled using the Page Size parameter, with a minimum value of 50.

External DocumentationTo learn more, visit the Authentik documentation.

Basic Parameters

Parameter	Description
Group Name	Query by the name of the group.
Members By Username	Query by a comma separated list of the group’s member usernames. Can be obtained by the `List Users` action.
Page Number	The page number being requested.
Page Size	Number of results to return per page.
Return All Pages	Automatically fetch all resources, page by page.

Advanced Parameters

Parameter	Description
Attributes	Query by the additional attributes.
Include Users	Include the group’s users in the response.
Is Superuser	Is the group designated as a superuser group.
Members By ID	Query by a comma separated list of the group’s member IDs. Can be obtained by the `List Users` action.
Order By	Which field to use when ordering the results.
Search	A 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": []
		}
	]
}