List Users - BlinkOps Documentation

List and query users. You can search for users 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
Name	Query by the name of the user.
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.
User Type	Query by the type of the user.
Username	Query by the username of the user.

Advanced Parameters

Parameter	Description
Attributes	Query by the additional attributes of the user.
Email	Query by the email of the user.
Group IDs	Query by a comma separated list of the user’s groups. Can be obtained by the `List Groups` action.
Group Names	Query by a comma separated list of the user’s groups. Can be obtained by the `List Groups` action.
Include Groups	Include the user’s groups in the response.
Is Active	Query by if the user active.
Is Superuser	Query by if the user is a superuser.
Order By	Which field to use when ordering the results.
Search	A search term.
UUID	Query by the UUID of the user.
User Path	Query by the path of the user.
User Path Starts With	Query by the path of the user.

Example Output

{
	"pagination": {
		"next": 2,
		"previous": 2,
		"count": 1,
		"current": 0,
		"total_pages": 0,
		"start_index": 2,
		"end_index": 3
	},
	"results": [
		{
			"pk": 4,
			"username": "<string>",
			"name": "<string>",
			"is_active": true,
			"last_login": null,
			"is_superuser": false,
			"groups": [],
			"groups_obj": [],
			"email": "<string>",
			"avatar": "<string>",
			"attributes": {},
			"uid": "<string>",
			"path": "<string>",
			"type": "<string>",
			"uuid": "<string>",
			"password_change_date": "2025-04-17T12:31:40.189741Z"
		},
		{
			"pk": 5,
			"username": "<string>",
			"name": "<string>",
			"is_active": true,
			"last_login": "<string>",
			"is_superuser": true,
			"groups": [
				"<string>"
			],
			"groups_obj": [
				{
					"pk": "<string>",
					"num_pk": 39383,
					"name": "<string>",
					"is_superuser": true,
					"parent": null,
					"parent_name": null,
					"attributes": {}
				}
			],
			"email": "<string>",
			"avatar": "<string>",
			"attributes": {},
			"uid": "<string>",
			"path": "<string>",
			"type": "<string>",
			"uuid": "<string>",
			"password_change_date": "2025-04-17T12:31:40.189741Z"
		}
	]
}