---
title: "Get Merchant or Partner User Info"
method: POST
path: "/v4/users/search"
tags: ["Gateway Features", "Users"]
---

# Get Merchant or Partner User Info

`POST /v4/users/search`

## Request

- Base URL: `https://sandbox.nmi.com/api`
- URL: `https://sandbox.nmi.com/api/v4/users/search`
- Auth: none required

<details>
<summary>Usage</summary>
This will return information on all users associated with a specific merchant or sub-affiliate account.
</details>

## Headers

- `Content-Type` string, required
- `Authorization` string, required

## Request body

- GetMerchantOrPartnerUserInfoRequest
  - `maxResults` string, required: Number of max results, any integer number from 1 to 1000.
  - `merchantId` string: Merchant ID.
  - `affiliateId` string: Affiliate ID. To get user information for a sub-affiliate account, pass in `affiliateId` instead of `merchantId`.

## Response `200`

Success

- object[]
  - `id` string: ID of merchant or partner.
  - `created` string, date-time: Timestamp when the merchant/partner was created.
  - `updated` string, date-time: Timestamp when the merchant/partner was last updated.
  - `firstName` string: First name of the merchant/partner.
  - `lastName` string: Last name of the merchant/partner.
  - `title` string: Title of the merchant/partner.
  - `email` string: Email address of the merchant/partner.
  - `username` string: Username of the merchant/partner.
  - `isTwoFactorEnabled` boolean: Indicates if two-factor authentication is enabled for the merchant/partner.
  - `permissions` object: Permissions assigned to the merchant/partner.
    - `merchants` boolean: Permission to manage merchants.
    - `resellers` boolean: Permission to manage resellers.
    - `transactions` boolean: Permission to manage transactions.
    - `billing` boolean: Permission to manage billing.
    - `commission` boolean: Permission to manage commissions.
    - `options` boolean: Permission to manage options.
    - `fees` boolean: Permission to manage fees.
    - `sublogin` boolean: Permission to manage sublogins.
    - `twoFactorLogin` boolean: Permission to manage two-factor login settings.
    - `googleAuthenticatorLogin` boolean: Permission to manage Google Authenticator login settings.
    - `viewReleaseNotes` boolean: Permission to view release notes.
    - `webhookConfig` boolean: Permission to configure webhooks.
    - `orderDevices` boolean: Permission to order devices.
    - `orderDeviceHistory` boolean: Permission to view order device history.
    - `useCustomerVault` boolean: Permission to use the customer vault.
  - `notifications` object: Notifications for the merchant/partner.
    - `releaseNotesEmails` boolean: Indicates if the user receives release notes emails.
    - `acuEmails` boolean: Indicates if the user receives Automatic Card Updater emails.
  - `viewVersion` integer: Version of the view.
  - `mainUser` boolean: Indicates if the merchant/partner is the main user.
  - `hasUsedCredentialsForApiLogin` boolean: Indicates if the merchant/partner has used credentials for API login.
  - `parent` object: Parent entity information.
    - `type` string: Type of the parent entity.
    - `id` string: ID of the parent entity.
  - `gatewayTitle` string: Title of the gateway.

---

[API](https://skmtc.dev/nmi/apis/payments-api.md) - [All operations](https://skmtc.dev/nmi/apis/payments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nmi/apis/payments-api/revisions/c03727f27e27?raw)