---
title: "Get user by email"
method: GET
path: "/api/user/by-email"
tags: ["User"]
---

# Get user by email

`GET /api/user/by-email`

## Request

- Base URL: `https://api.sponsorunited.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.sponsorunited.com/api/user/by-email`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sponsorunited/apis/sponsorunited-api/docs/api/user/by-email/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a user by their email address. Includes soft-deleted users in the search

## Query parameters

- `email` string, required

## Response `200`

A user with the given email

- UserLightResource
  - `user` object
    - `id` integer
    - `name` string
    - `email` string
    - `roles` Role[]
      - `id` integer
      - `name` string
      - `display_name` string
      - `description` string
      - `created_at` string, date-time
      - `updated_at` string, date-time
    - `is_external` boolean
    - `force_new_password` integer
    - `verified` integer
    - `settings` UserSetting[]
      - `id` integer
      - `type` string
      - `payload` object

---

[API](https://skmtc.dev/sponsorunited/apis/sponsorunited-api.md) - [All operations](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sponsorunited/apis/sponsorunited-api/revisions/cbf1ca5bff8f?raw)