---
title: "Search Users"
method: GET
path: "/business/v2/employees"
tags: ["Users"]
---

# Search Users

`GET /business/v2/employees`

Endpoint to find `Users` using filtering parameters.

## Query parameters

- `customreferenceId` string — The reference of the `User` in an external system.
- `name` string — The name of the `User`.
- `surname` string — The surname of the `User`.
- `visible` boolean — The visibility property of the `User`.
- `jobTitle` string — The job title of the `User`.
- `department` string — The department of the `User`.
- `email` string — The email address of the `User`.
- `mobile` string — The mobile number of the `User`.
- `status` 'ACTIVE' | 'INACTIVE' | 'BLOCKED' | 'SUSPENDED' | 'PENDING' | 'ARCHIVED'
- `id` string — The ID of the `User`.
- `groupId` string — The ID of the `Group` the `User` is a member of.
- `reportsTo` string[] — The IDs of the `User` resources to which they could report to.
- `workStatus` WorkStatus[] — Filters users by their work status.
- `expensePolicyId` string[] — The IDs of the `ExpensePolicy` resources to search for.
- `excludeExpensePolicyId` string[] — The IDs of the `ExpensePolicy` resources to exclude. `User` resources with no `ExpensePolicy` assigned will be excluded.
- `withoutExpensePolicy` boolean — Whether to search for `User` resources with no `ExpensePolicy` assigned.
- `p` integer — It indicates the specific page to display (the counter starts from zero).
- `s` integer — It indicates the number of items per page.
- `d` 'ASC' | 'DESC' — It indicates how the pages are ordered.
- `props` string[] — It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the `props` parameter in the request.

## Response `200`

The result array contains `Users`.

- Users
  - `total` integer — It represents the total number of available items in the list.
  - `pages` integer — It represents the total number of available pages.
  - `page_size` integer — It represents the number of items per page.
  - `current_page` integer — It indicates the current page (the counter starts from zero).
  - `results_size` integer — It indicates the size of the array results.
  - `results` UserItem[]
    - `id` string — The `User` ID.
    - `name` string — The name of the `User` (sortable: yes).
    - `surname` string — The surname of the `User` (sortable: yes).
    - `middlename` string — The middlename of the `User` (sortable: no).
    - `dob` string — The Date of birth of the `User`.
    - `job_title` string — The job title of the `User` (sortable: yes).
    - `department` string — The department of the `User` (sortable: no).
    - `email` string — The email address of the `User` (sortable: no).
    - `mobile` string — The mobile number of the `User` including the country code (sortable: no).
    - `custom_reference_id` string — The reference of the employee in an external system (sortable: yes).
    - `status` 'ACTIVE' | 'INACTIVE' | 'BLOCKED' | 'SUSPENDED' | 'PENDING' | 'ARCHIVED'
    - `visible` boolean — It determines whether the `User` is visible in the web console (sortable: yes).
    - `groups` string[] — The list of `Groups` ID the `User` is member of (sortable: no).
    - `reports_to` string — The ID of the `User` it reports to.
    - `roles` UserRole[] — The list of `UserRole` of the `User`.
      - `id` string — The ID of the `UserRole`.
      - `name` string — The name of the `UserRole`.
      - `description` string — The description of the `UserRole`.
      - `scope` string — The scope of the `UserRole`.
    - `contact_id` string — The ID of the `Contact` assigned to the `User`. This information can be updated from the [Add Contact](ref:contact-add) and [Update Contact](ref:contact-update) endpoints.
    - `creation_time` string — The date and time when the `User` was created (sortable: yes).
    - `last_update` string — The date and time when the `User` was last updated (sortable: yes).
    - `work_status` 'AVAILABLE' | 'OUT_OF_OFFICE'

## Other responses

- `400` — Your request has missing arguments or is malformed.

---

[API](https://skmtc.net/soldo/apis/soldo-business-api-v2-0.md) · [All operations](https://skmtc.net/soldo/apis/soldo-business-api-v2-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/soldo/soldo-business-api-v2-0/revisions/7be21448a2b3/schema)