Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blinkops.com/llms.txt

Use this file to discover all available pages before exploring further.

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

ParameterDescription
NameQuery by the name of the user.
Page NumberThe page number being requested.
Page SizeNumber of results to return per page.
Return All PagesAutomatically fetch all resources, page by page.
User TypeQuery by the type of the user.
UsernameQuery by the username of the user.

​
Advanced Parameters

ParameterDescription
AttributesQuery by the additional attributes of the user.
EmailQuery by the email of the user.
Group IDsQuery by a comma separated list of the user’s groups. Can be obtained by the List Groups action.
Group NamesQuery by a comma separated list of the user’s groups. Can be obtained by the List Groups action.
Include GroupsInclude the user’s groups in the response.
Is ActiveQuery by if the user active.
Is SuperuserQuery by if the user is a superuser.
Order ByWhich field to use when ordering the results.
SearchA search term.
UUIDQuery by the UUID of the user.
User PathQuery by the path of the user.
User Path Starts WithQuery 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"
		}
	]
}

​
Workflow Library Example

List Users with Authentik and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop