---
title: "Get-NectarUser"
slug: "get-nectaruser"
updated: 2023-05-15T17:41:30Z
published: 2023-05-15T17:41:30Z
canonical: "support.nectarcorp.com/get-nectaruser"
---

> ## 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-NectarUser

Get information about 1 or more users via Nectar DXP.

## Syntax

```
Get-NectarUser
  -SearchQuery  <String>
  -TenantName  <String>
  -PageSize  <Int32>
  -ResultSize  <Int32>
```

## Examples

### Example 1

```
Get-NectarUser -SearchQuery tferguson
```

## Parameters

**-SearchQuery <String>** A full or partial match of the user name. Will do an 'includes' type search by default. So searching for user@domain.com would return Auser@domain.com, Buser@domain.com etc. For a specific match, enclose the name in square brackets IE: [user@domain.com]

| Parameter | Value |
| --- | --- |
| Required | true |
| Position | 1 |
| Required | true |
| 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 |

**-PageSize <Int32>**

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

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

| Parameter | Value |
| --- | --- |
| Required | false |
| Position | 4 |
| Required | false |
| Default Value | 0 |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |