---
title: "Get-NectarUserAccount"
slug: "get-nectaruseraccount"
updated: 2022-10-18T14:25:31Z
published: 2022-10-18T14:25:32Z
canonical: "support.nectarcorp.com/get-nectaruseraccount"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.nectarcorp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get-NectarUserAccount

Get information about one or more Nectar DXP user accounts.

## Syntax

```
Get-NectarUserAccount
  -SearchQuery  <String>
  -TenantName  <String>
  -ResultSize  <Int32>
```

## Examples

### Example 1

```
Get-NectarUserAccount -SearchQuery tferguson@contoso.com
```

Returns information about the user tferguson@contoso.com

## Parameters

**-SearchQuery <String>** A full or partial match of the user's first or last name or email address

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 1 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |

**-TenantName <String>** The name of the Nectar DXP tenant. Used in multi-tenant configurations.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 2 |
| Required | false |
| Default Value | None |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |

**-ResultSize <Int32>** The number of results to return. Defaults to 1000.

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 3 |
| Required | false |
| Default Value | 1000 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |