> ## 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 Users

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`.

<Note>
  External Documentation

  To learn more, visit the [Authentik documentation](https://docs.goauthentik.io/docs/developer-docs/api/reference/core-users-list).
</Note>

## Basic Parameters

<div className="integrations-table">
  | 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. |
</div>

## Advanced Parameters

<div className="integrations-table">
  | 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. |
</div>

## Example Output

```json theme={"dark"}
{
	"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](https://library.blinkops.com/workflows/list-users-with-authentik-and-send-results-via-email)

<div className="iframe-wrapper">
  <div className="iframe-media">
    <img src="https://mintcdn.com/blinkops-2/ojHYuDeYX5FWuN8a/img/Icons/play-box.svg?fit=max&auto=format&n=ojHYuDeYX5FWuN8a&q=85&s=b8af968e71438a9499c3223c9bd29fb2" alt="Workflow Library" width="16" height="16" data-path="img/Icons/play-box.svg" />

    Preview this Workflow on desktop
  </div>

  <iframe className="iframe" src="https://library.blinkops.com/workflows/list-users-with-authentik-and-send-results-via-email/canvas" />
</div>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.