---
title: "Find users based on search parameters."
method: POST
path: "/api/users/list"
tags: ["User"]
---

# Find users based on search parameters.

`POST /api/users/list`

## Query parameters

- `Sort.Field` string
- `Sort.Dir` 'ascending' | 'descending' — Specify sorting direction.
- `Skip` integer
- `Take` integer

## Request body

- UserRequestFindParameters — Parameters used for searching/finding users.
  - `firstName` string, nullable — Filter users based on their first name.
  - `lastName` string, nullable — Filter users based on their last name.
  - `emailAddress` string, nullable — Email address
  - `phoneNumber` string, nullable — Phone number
  - `roles` string[], nullable — Filter users to those with any of the provided roles.
  - `omniSearch` string, nullable — Search for users based on a string that should match any of the user's first name, last name, email address, phone number or roles.
  - `includeDeleted` boolean — When true, inactive/deleted users are included in the results. Defaults to false, in which case only active users are returned.

## Response `200`

List of users matching the filters

- UserListDto[]
  - `id` string, required — Unique id associated to this entity.
  - `employeeId` string, nullable — This property represents the unique identifier of an employee.
  - `firstName` string, nullable — First name
  - `lastName` string, nullable — Last name
  - `emailAddress` string, email, nullable — Email address
  - `phoneNumber` string, nullable — Email address
  - `roleIds` CommonReferenceDto[], nullable — Roles associated to the user.
    - `id` string, nullable — Unique Id associated to the referenced object
    - `name` string, nullable — Descriptive name associated to the object
  - `deleted` boolean — Indicates whether this user has been deleted

---

[API](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi.md) · [All operations](https://skmtc.net/fulcrumpro/apis/fulcrum-publicapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fulcrumpro/fulcrum-publicapi/versions/1b5649cff14a/schema)