---
title: "getUserList"
method: GET
path: "/users/"
tags: ["users"]
---

# getUserList

`GET /users/`

## Request

- Base URL: `https://api-hub.extensiv.com`
- URL: `https://api-hub.extensiv.com/users/`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/extensiv/apis/hub/docs/users/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists users

## Query parameters

- `appName` 'can3pl' | 'canOrderManager' | 'canWarehouseManagerClassicAdmin' | 'canWarehouseManagerUnlimitedAdmin' | 'canWarehouseManagerCustomerPortal' | 'canWarehouseManagerIntegrations' | 'canWarehouseManagerMobile' | 'canWarehouseManagerAccountManager' | 'canIntegrationManager' | 'canBilling' | 'canNetworkManager' | 'canSignUp' | 'canManagementConsole' | 'canAdmin' | 'canFM' | 'canSmartScan' | 'canAccountingIntegration' | 'canBusinessAnalytics' | 'canAI'
- `orgkey` string, uuid

## Response `200`

OK

- object
  - `data` IUser[]
    - `orgKey` string, uuid, required
    - `userId` string, uuid, required
    - `warehouseManagerUserId` integer
    - `tplUserId` string
    - `integrationManagerUserId` string
    - `orderManagerUserId` string
    - `defaultAppName` 'Hub' | 'Billing' | '3PLWarehouseManager' | 'OrderManager' | 'NetworkManager' | 'IntegrationManager' | 'WarehouseManagerClassicAdmin' | 'WarehouseManagerUnlimitedAdmin' | 'WarehouseManagerCustomerPortal' | 'WarehouseManagerIntegrations' | 'WarehouseManagerMobile' | 'WarehouseManagerAccountManager' | 'Signup' | 'ManagementConsole' | 'Admin' | 'FulfillmentMarketplace' | 'SmartScan' | 'AccountingIntegration' | 'BusinessAnalytics' | 'AI', required: What App the user will be redirected to when they log in
    - `jobTitle` string
    - `role` string, uuid: ID of the user's role
    - `productAccess` IProductAccess
      - `can3pl` boolean: Can this Org access 3pl Warehouse Manager?
      - `canOrderManager` boolean: Can this Org access Order Manager Web?
      - `canWarehouseManagerClassicAdmin` boolean: Can this Org access Warehouse Manager Classic Admin?
      - `canWarehouseManagerUnlimitedAdmin` boolean: Can this Org access Warehouse Manager Unlimitedd Admin?
      - `canWarehouseManagerCustomerPortal` boolean: Can this Org access Warehouse Manager Customer Portal?
      - `canWarehouseManagerIntegrations` boolean: Can this Org access Warehouse Manager Integrations?
      - `canWarehouseManagerMobile` boolean: Can this Org access Warehouse Manager Mobile?
      - `canWarehouseManagerAccountManager` boolean: Can this Org access Warehouse Manager Account Manager?
      - `canIntegrationManager` boolean: Can this Org access Integration Manager?
      - `canBilling` boolean: Can this Org access Billing?
      - `canNetworkManager` boolean: Can this Org access Network Manager?
      - `canSignUp` boolean: Can this Org access 3pl Warehouse Manager Sign Up?
      - `canManagementConsole` boolean: Can this Org access Management Console?
      - `canAdmin` boolean: Can this Org access Admin?
      - `canFM` boolean: Can this Org access Fulfilment?
      - `canSmartScan` boolean: Can this Org access SmartScan?
      - `canAccountingIntegration` boolean: Can this Org access Accounting Integration?
      - `canBusinessAnalytics` boolean: Can this Org access Business Analytics?
      - `canAI` boolean: Can this Org access AI?
    - `security` IOrgUserSecurity
      - `mfaEnabled` boolean, required
    - `externalUsers` object
    - `isC2` boolean
    - `lastLoginTimestamp` number
    - `id` string, uuid, required
    - `email` string, email, required
    - `firstName` string
    - `lastName` string
    - `defaultOrgKey` string, uuid: Organization selected when the user logs in
    - `status` 'UNCONFIRMED' | 'CONFIRMED' | 'ARCHIVED' | 'COMPROMISED' | 'UNKNOWN' | 'RESET_REQUIRED' | 'FORCE_CHANGE_PASSWORD'
    - `isSuperUser` boolean
    - `image` string, uri
    - `settings` IUserSettings
      - `displayLanguage` string

## Other responses

- `400`: Resource does not exist<br>Invalid request<br>Validation error<br>Database constraint error
- `403`: Insufficient permissions

---

[API](https://skmtc.dev/extensiv/apis/hub.md) - [All operations](https://skmtc.dev/extensiv/apis/hub/llms.txt) - [OpenAPI document](https://skmtc.dev/extensiv/apis/hub/revisions/3f2a4976ee74?raw)