---
title: "Search users by username or Discord ID"
method: GET
path: "/api/v1/users/search"
tags: ["users"]
---

# Search users by username or Discord ID

`GET /api/v1/users/search`

## Request

- Base URL: `http://localhost:3000`
- URL: `http://localhost:3000/api/v1/users/search`
- Auth: HTTP bearer

Search users by username or Discord ID

## Query parameters

- `q` string, required
- `limit` number

## Response `200`

Default Response

- object
  - `success` true, required
  - `data` object, required
    - `users` object[]
      - `discordId` string
      - `username` string
      - `nickname` string, nullable
      - `farmName` string, nullable
      - `image` string, nullable
      - `color` string, nullable
      - `topRole` string, nullable
  - `meta` object, required
    - `timestamp` number, required

## Other responses

- `400`: Default Response
- `401`: Default Response
- `403`: Default Response
- `500`: Default Response

## Changes

- **2026-09-20** `b4fa9123ba90`: 1 info
  - added the optional property `data/users/items/color` to the response with the `200` status

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

---

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