---
title: "get users list for current tenant"
method: POST
path: "/api/v{version}/users/search"
tags: ["users"]
---

# get users list for current tenant

`POST /api/v{version}/users/search`

## Request

- Base URL: `https://api.zrexpress.app`
- URL: `https://api.zrexpress.app/api/v{version}/users/search`
- Auth: HTTP bearer and API key in header `X-Api-Key`
- TypeScript: <https://skmtc.dev/zrexpress/apis/zrexpress-api/docs/api/v:version/users/search/post.ts> (a function with typed inputs; its response is checked against the schema)

get users list for current tenant with pagination and filtering support

## Path parameters

- `version` string, required

## Headers

- `X-Tenant` string, required

## Request body

- SearchUsersRequest
  - `advancedSearch` Search
    - `fields` string[], nullable
    - `keyword` string, nullable
  - `keyword` string, nullable
  - `advancedFilter` Filter
    - `logic` string, nullable
    - `filters` Filter[], nullable
    - `field` string, nullable
    - `operator` string, nullable
    - `value` unknown
  - `pageSize` integer
  - `pageNumber` integer
  - `orderBy` string[], nullable
  - `roles` string[], nullable

## Response `200`

OK

## Changes

- **2026-11-03** `652262902df9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zrexpress/apis/zrexpress-api/changes/api/v:version/users/search/post.md)

---

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