---
title: "Search Users"
method: GET
path: "/api/v1/users/search"
tags: ["User Management"]
---

# Search Users

`GET /api/v1/users/search`

Search & Retrieve Users, ACCESS LEVEL: SUPER_ADMIN, PARTNER, MERCHANT, BRANCH

## Query parameters

- `pageProperties` SearchPageable, required
  - `pageNumber` integer
  - `sortDirection` 'ASC' | 'DESC'
  - `pageSize` integer
  - `sortBy` string
- `searchCriteria` UserSearchCriteria, required
  - `id` string, uuid
  - `username` string
  - `phoneNumber` string
  - `createdTimeTo` string, date
  - `createdTimeFrom` string, date
  - `firstName` string
  - `lastName` string
  - `businessUnitId` string, uuid
  - `userType` string
  - `text` string
  - `owner` boolean
  - `businessUnitHierarchies` string[]

## Response `200`

OK

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/edfapay/apis/revamp.md) · [All operations](https://skmtc.net/edfapay/apis/revamp/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/edfapay/revamp/revisions/8104cc1c9e38/schema)