---
title: "getUserProperty"
canonical: "https://support.appfire.com/space/PSCONF/15304430/getUserProperty"
format: markdown
---
> Macro (aura-html)

> Macro (table-plus)
> 
> |  |  |  |  |
> | --- | --- | --- | --- |
> | **Syntax** | getUserProperty(userNameOrKey, propertyKey) | **Package** |  |
> | **Alias** |  | **Pkg Usage** |  |

## Description

> Macro (excerpt)
> 
> Gets the specified user property.

Gets the specified user property.

## Parameters

> Macro (table-plus)
> 
> | Parameter name | Type | Required | Description |
> | --- | --- | --- | --- |
> | userNameOrKey | String | Yes | User name or user key to get a property for. |
> | propertyKey | String | Yes | Key of the property to retrieve. |

## Return Type

**String**

## Example

```javascript
string customProperty = getUserProperty("jdoe", "custom.property");
```

## See also

> Macro (contentbylabel)