---
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_CALENDARTYPE` => CalendarAccount} that contains all the additional accounts the user wants to see google calendar events for
  - `calendarOptions` ModelsCalendarOptions
    - `bufferTime` ModelsBufferTimeOptions
      - `enabled` boolean
      - `time` integer
    - `workingHours` ModelsWorkingHoursOptions
      - `enabled` boolean
      - `endTime` number
      - `startTime` number
  - `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
  - `isPremium` boolean
  - `lastName` string
  - `numEventsCreated` integer
  - `picture` string
  - `primaryAccountKey` string — The calendarAccountKey of the account the user first signed in with
  - `stripeCustomerId` string — Stripe customer ID
  - `timezoneOffset` integer

## Changes

- **2024-05-15** `0feff3c90ef7` — 1 breaking, 1 warning
  - added the new required `query` request parameter `query`
  - deleted the `path` request parameter `userId`
- **2024-04-03** `0bfa7dd9df0d` — 1 breaking, 1 warning
  - added the new path request parameter `userId`
  - deleted the `query` request parameter `query`
- **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

[Full 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/c4d497429354/schema)