---
title: "Get users by query."
method: GET
path: "/api/users"
tags: ["Users"]
---

# Get users by query.

`GET /api/users`

Search the user by query that contains the email address or the part of the email address.

## Query parameters

- `query` string

## Response `200`

Users returned.

- UserDto[]
  - `_links` object, required — The links.
  - `id` string, required — The ID of the user.
  - `email` string, required — The email of the user. Unique value.
  - `displayName` string, required — The display name (usually first name and last name) of the user.
  - `isLocked` boolean, required — Determines if the user is locked.
  - `permissions` string[], required — Additional permissions for the user.

## Other responses

- `500` — Operation failed.

---

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