---
title: "getUserList"
canonical: "https://support.appfire.com/space/BCCLI/1529054547/getUserList"
format: markdown
---
> Macro (aura-html)

See also: [Actions](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65766635)

> Macro (details)
> 
> | **Description** | Get a list of users with regex filtering based on name or key. |
> | --- | --- |
> | **Required Parameters** | [workspace](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65765634) |
> | **Optional Parameters** | [regex](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65767227), [limit](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65768162), [columns](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65766357), [select](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65768292), [options](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65767811), [outputType](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65768516), [file](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65768095), [encoding](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65766303), [append](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65765977) |
> | **Type** | [Get](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65768932/Action+Types#ActionTypes-Get) |
> | **Category** | [Users](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65766329/Action+Categories#ActionCategories-Users) |
> | **Output Formats** | , |
> | **Replacement Variables** |  |
> | **Since Version** | 12.0 |
> | **Examples** | [getUserList](https://appfire.atlassian.net/wiki/spaces/BCCLI/pages/65766633/Examples#getUserList) |

## Related How To's

> Macro (cql-query)