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

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

> Macro (details)
> 
> | **Description** | Get list of users with optional regex filtering by user id. If a group is provided, only members of the group will be included. For Cloud, group defaults to confluence-users. |
> | --- | --- |
> | **Required Parameters** |  |
> | **Optional Parameters** | [group](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459001), [outputFormat](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68454543), [limit](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459009), [regex](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68458942), [outputType](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459055), [file](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68455055), [append](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68454814), [columns](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459679), [select](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68453905), [options](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459041), [encoding](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68458746) |
> | **Type** | [Get](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68455033/Action+Types#ActionTypes-Get) |
> | **Category** | [Users](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68455044/Action+Categories#ActionCategories-Users) |
> | **Output Formats** | 1 - basic, 2 - email when available, 999 - all |
> | **Replacement Variables** |  |
> | **Hosting** | cloud,server,datacenter |
> | **Since Version** |  |
> | **Examples** | [getUserList](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68458176/Examples#Examples-getUserList) |

## Related How To's

> Macro (cql-query)