---
title: "GET /api/v1.0/users/search"
method: GET
path: "/api/v1.0/users/search"
tags: ["Users"]
---

# GET /api/v1.0/users/search

`GET /api/v1.0/users/search`

## Query parameters

- `searchQuery` string, required
- `hasUserLoggedIn` boolean
- `userDiscriminator` 'All' | 'ApplicationUsers' | 'RestaurantUsers' | 'HydraUsers'
- `searchIn` 'Generic' | 'Id' | 'Email' | 'Phone' | 'CustomerName' | 'IdOrPhone' | 'IdOrCustomerName'
- `pageIndex` integer
- `pageSize` integer

## Response `200`

OK

- RestApiPaginationResultUserSearch — Rest api pagination result
  - `Page` integer, required — Current page index
  - `Limit` integer, required — Current page size
  - `TotalRecordCount` integer, required — Total record count
  - `Data` UserSearch[], required — Generic data object.
    - `Id` integer — User Id
    - `PhoneNumber` string — Phone Number
    - `Email` string — Email
    - `CustomerName` string — Customer Name
    - `HasLoggedIn` boolean — Has Logged In
    - `UserDiscriminator` 'All' | 'ApplicationUsers' | 'RestaurantUsers' | 'HydraUsers' — User Discriminator
    - `TsCreate` string, date-time — Timestamp Created
    - `WhiteLabelConfigs` UserWhiteLabelConfig[] — WhiteLabel Configs
      - `Id` integer — Identifier
      - `ConfigId` integer — WlConfigId
      - `AppId` string — Brand Id
      - `Name` string — WhiteLabel Name
      - `Level` 'None' | 'Owner' | 'StoreOwner' | 'PropertyOwner' | 'ManagedOwner' | 'Integrator' | 'PropertyManager' | 'StoreManager' | 'StoreStaff' | 'StaffMember' | 'StoreReadOnlyAccess' | 'FinanceManager' | 'Support' — WhiteLabel Access Level
    - `UserType` string — User Type

## Other responses

- `400` — BadRequest
- `401` — Authentication has been denied for this request.
- `403` — Successful authentication, but authorization has been denied for this request.

---

[API](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0.md) · [All operations](https://skmtc.net/flipdish/apis/flipdish-open-api-v1-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/flipdish/flipdish-open-api-v1-0/versions/a72c0465da74/schema)