---
title: "Search for users"
method: GET
path: "/api/users/search"
tags: ["users"]
---

# Search for users

`GET /api/users/search`

Search for a user by email address.

### Permissions & Context:
- Requires administrative privileges (`api-key` of an administrator).
- Used to verify account existence or map email addresses to platform usernames.

## Query parameters

- `email` string, required

## Response `200`

successful

- ExtendedUser — The representation of a user
  - `type_of` string
  - `id` integer
  - `username` string
  - `name` string
  - `summary` string, nullable
  - `twitter_username` string
  - `github_username` string
  - `email` string, nullable — Email (requires authentication and if user allows displaying email on their profile) or nil
  - `website_url` string, nullable
  - `location` string, nullable
  - `joined_at` string
  - `profile_image` string
  - `badge_ids` integer[] — ids of the badges awarded to the user

## Changes

> 59 revisions in range; 8 could not be searched.

- **2026-07-13** (v1) `189b62b952ea` — 1 info
  - endpoint added
- **2026-07-13** (v1) `7db6ba099285` — 1 info
  - endpoint added
- **2023-01-10** (v1) `754f8b25f815` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/forem/apis/forem-api-v1/changes/api/users/search/get.md)

---

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