---
title: "Search Users"
method: GET
path: "/v1/user/"
tags: ["Users"]
---

# Search Users

`GET /v1/user/`

Search for users that match the provided search terms.

Keywords are searched for in the _firstname_, _lastname_, _email_, _address_, and _phone numbers (home, work and mobile)_ fields.

## Query parameters

- `query` string, nullable
- `skip` integer, nullable
- `limit` integer, nullable
- `sort_direction` 'asc' | 'desc' — Direction to sort the `sort_column` - ascending or descending.
- `date_start` string, date-time, nullable
- `date_cut_off` string, date-time, nullable
- `sort_column` 'updated_at' | 'created_at' | 'id' — Which column to sort on
- `is_active` boolean, nullable
- `role_id` integer, nullable

## Response `200`

Successful Response

- ApiGenericListResponseUnifiedUserShortModel
  - `error` boolean — A boolean error indicator.
  - `message` string, nullable — Optional message.
  - `data` UnifiedUserShortModel[], nullable — The response data for any given request.
    - `id` integer, required — The user identifier
    - `firstName` string, nullable, required — The given name of a user.
    - `lastName` string, nullable, required — The family name of a user.
    - `email` string, required — The email of address of the user, the email should be unique.
    - `updatedAt` string, date-time, required
    - `createdAt` string, date-time, required
    - `companyUser` CompanyUserShortModel
      - `id` integer, required — The company user record ID.
      - `role` RoleModel, required — Represents a user role.
        - `id` integer, nullable — The role identifier
        - `name` string — What role the user has
        - `slug` string, required — URL-friendly version of the role
      - `isActive` boolean, required — Indicates that this user is active in the company.
      - `employeeId` string, nullable, required — An external employee ID so that it can be correlated with an external system.
      - `position` string, nullable, required — Optionally, specify the users position in the company.

## Other responses

- `400` — Business Logic Error
- `403` — Permission Error
- `404` — Records Not Found
- `409` — Integrity Error or Data Conflict
- `422` — Validation Error

---

[API](https://skmtc.dev/salussafety/apis/salus-developer-api.md) · [All operations](https://skmtc.dev/salussafety/apis/salus-developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/salussafety/salus-developer-api/revisions/ef065f44da25/schema)