---
title: "Search users by name"
method: GET
path: "/api/users/search"
tags: ["Users"]
---

# Search users by name

`GET /api/users/search`

## 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/users/search`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sponsorunited/apis/sponsorunited-api/docs/api/users/search/get.ts> (a function with typed inputs; its response is checked against the schema)

Search for a specific user by name. Usually used on typeaheads.

## Query parameters

- `UserSearchRequest` UserSearchRequest, required
  - `search` string, required
  - `is_external` boolean
  - `organization` string
  - `with_deleted` boolean

## Response `200`

An array with simple items.

- GenericEntity[]
  - `id` integer
  - `name` string

---

[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)