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

## Basic Parameters

<div className="integrations-table">
  | Parameter | Description                                                      |
  | --------- | ---------------------------------------------------------------- |
  | Per Page  | Number of results per page, valid range is 1-100.                |
  | Query     | Full text query string, search in firstname, lastname and email. |
</div>

## Advanced Parameters

<div className="integrations-table">
  | Parameter       | Description                                                                       |
  | --------------- | --------------------------------------------------------------------------------- |
  | Active          | If true, returns only the users who have logged in on the platform at least once. |
  | Email           | Search by email (exact).                                                          |
  | External ID     | Search by external ID (exact).                                                    |
  | Firstname       | Search by firstname (exact).                                                      |
  | Lastname        | Search by lastname (exact).                                                       |
  | Organization ID | Returns the users who have a profile linked to this organization.                 |
  | Role ID         | Returns all the users who have this role.                                         |
</div>

## Example Output

```json theme={"dark"}
[
	{
		"external_id": "string",
		"firstname": "string",
		"lastname": "string",
		"middlename": "string",
		"email": "string",
		"language": "string",
		"timezone": "string",
		"mobile_phone_number": "string",
		"profiles": [
			{
				"role_id": "string",
				"employees_perimeter": {
					"operator": "=",
					"organization_id": "string",
					"organization_group_id": "string",
					"custom_field_filters": [
						{
							"custom_field_id": "string",
							"operator": "=",
							"value": "string"
						}
					]
				},
				"id": "string"
			}
		],
		"id": "string",
		"created_at": "2023-11-13T19:38:53.991Z",
		"updated_at": "2023-11-13T19:38:53.991Z"
	}
]
```

## Workflow Library Example

[List Users with Ukg Hr and Send Results Via Email](https://library.blinkops.com/workflows/list-users-with-ukg-hr-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-ukg-hr-and-send-results-via-email/canvas" />
</div>