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

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

> Macro (details)
> 
> | **Description** | List a project's customers with optional filtering by regex on customer email, name, or id. |
> | --- | --- |
> | **Required Parameters** | [project](https://appfire.atlassian.net/wiki/pages/createpage.action?spaceKey=csoap&title=--project&linkCreation=true&fromPageId=1493045227) |
> | **Optional Parameters** | [regex](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68458942), [limit](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459009), [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/1493044789/JSM+Client+Action+Types#JSMClientActionTypes-Get) |
> | **Category** | [Users](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/1493044771/JSM+Client+Action+Categories#JSMClientActionCategories-Users) |
> | **Output Formats** |  |
> | **Replacement Variables** | customer, customerName, customerEmail |
> | **Hosting** | cloud |
> | **Since Version** |  |
> | **Examples** |  |

## Related How To's

> Macro (cql-query)