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

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

> Macro (details)
> 
> | **Description** | Get information about this client. |
> | --- | --- |
> | **Required Parameters** |  |
> | **Optional Parameters** | [outputFormat](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68454543), [outputType](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459055), [file](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68455055), [limit](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68459009), [regex](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68458942), [append](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68454814), [encoding](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68458746), [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) |
> | **Type** | [Get](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68455033/Action+Types#ActionTypes-Get) |
> | **Category** | [Info](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68455044/Action+Categories#ActionCategories-Info) |
> | **Output Formats** | 1 - basic, 2 - details and JVM, 11 - action list, 12 - parameter list, 13 - client list, 14 - category list, 21 - JSON representation of client related metadata, 22 - JSON representation of shell related metadata |
> | **Replacement Variables** |  |
> | **Hosting** |  |
> | **Since Version** |  |
> | **Examples** | [getClientInfo](https://appfire.atlassian.net/wiki/spaces/CSOAP/pages/68458176/Examples#Examples-getClientInfo) |

## Related How To's

> Macro (cql-query)