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

# Search users

`GET /v1/Users`

Search for one or more users.

## Query parameters

- `search.user_id` string[]
- `search.agent_id` string[]
- `search.customer_hierarchy_id` string[]
- `search.login` string[]
- `search.first_name` string[]
- `search.last_name` string[]
- `search.email` string[]
- `search.active` boolean
- `search.created_date_start` string, date-time
- `search.created_date_end` string, date-time
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsUser
  - `ok` boolean
  - `has_more` boolean — Helper for pagination. Indicates there are more records returned.
  - `record_count` integer — Total number of records found by the search.
  - `records` RevAppModelsUser[] — List of records returned.
    - `user_id` integer — Primary identifier for this user.
    - `first_name` string
    - `last_name` string
    - `login_name` string — a.k.a. Username.
    - `email` string — Used for system and account maintenance notification.
    - `created_by` integer — Foreign identifier indicating the user who created this.
    - `created_date` string, date-time — Date and time this user was created.
    - `agent_id` integer — If this user is associated with an agent, this is the ID of the agent object.
    - `customer_hierarchy_id` integer — If this user is associated with a customer, this is the ID of the customer hierarchy object.
    - `active` boolean — Indicates whether the user can log in.
    - `roles` RevAppModelsRole[] — List of security roles this user fills (a.k.a. system permissions)
      - `role_id` integer — Primary identifier for this role.
      - `description` string — Short description of the role (i.e. the name).
      - `links` RevAppComponentsLink[]
        - `rel` string
        - `href` string
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string

## Other responses

- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/versions/135571434f6c/schema)