---
title: "Returns users that match the search query"
method: GET
path: "/users"
tags: ["users"]
---

# Returns users that match the search query

`GET /users`

## Query parameters

- `query` string, required

## Response `200`

An array of user profile objects

- ModelsUser[]
  - `_id` string — Profile info
  - `calendarAccounts` object — CalendarAccounts is a mapping from {email => CalendarAccount} that contains all the additional accounts the user wants to see google calendar events for
  - `email` string
  - `firstName` string
  - `hasCustomName` boolean — Whether the user has set a custom name for themselves, i.e. don't change their name when they sign in
  - `lastName` string
  - `picture` string
  - `timezoneOffset` integer

## Changes

- **2022-08-10** `bb0279b9295d` — 1 info
  - endpoint added
- **2022-07-31** `337bd61ec7a7` — 1 breaking
  - api path removed without deprecation
- **2022-06-30** `ba01f1ad1d5e` — 1 info
  - endpoint added
- **2022-05-18** `c8572ecc9480` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/schej-it/apis/schej-it-api/changes/users/get.md)

---

[API](https://skmtc.dev/schej-it/apis/schej-it-api.md) · [All operations](https://skmtc.dev/schej-it/apis/schej-it-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/schej-it/schej-it-api/revisions/519c29d7fa5e/schema)