---
title: "searchOrganizations"
method: GET
path: "/orgs/search"
tags: ["orgs"]
---

# searchOrganizations

`GET /orgs/search`

## Request

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

Search organizations

## Query parameters

- `search` string
- `filter` string
- `operator1` 'AND' | 'OR'
- `operator2` 'AND' | 'OR'
- `from` integer, required
- `after` string
- `sort` string
- `maxResults` integer
- `fields` string

## Response `200`

OK

- object
  - `data` OpenSearchResultIOrganization
    - `count` number, required: Total results
    - `searchAfter` union[]
      - union
        - number
        - string
    - `items` IOrganization[], required
      - `key` string, uuid, required
      - `displayName` string, required
      - `extensivId` string: System assigned on create
      - `salesForceCustomerId` string
      - `isInternalTestOrg` boolean
      - `ownerUserEmail` string, email
      - `isSuperOrg` boolean
      - `isC2` boolean
      - `isEssential` boolean
      - `logo` string, uri
      - `loginContent` string, uri
      - `phoneNumber` string
      - `settings` IOrgSettings
        - `aiLogoImage` string, uri, nullable
        - `aiThemeColor` string, nullable
        - `aiTier` 'Free' | 'Paid', nullable
        - `favorites` string[]
      - `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?
      - `productsID` IProductsID
        - `tplId` number
        - `tplGuid` string: ID from 3W
        - `warehouseManagerCustomerID` string: ID from WM
        - `integrationManagerAccountID` string: ID from IM
        - `orderManagerCompanyID` string: ID from OM
      - `productIDs` IProductIDs
        - `imIds` IAppIdType[]
          - `name` string, required
          - `id` string, required
          - `disabled` boolean, required
      - `security` IOrgSecurity
        - `mfaEnabled` boolean, required

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