---
title: "GET /api/users"
method: GET
path: "/api/users"
tags: ["UserApi"]
---

# GET /api/users

`GET /api/users`

## Request

- Base URL: `https://vocadb.net` (the document declares no server; this is the origin it was published from)
- URL: `https://vocadb.net/api/users`
- Auth: none declared
- TypeScript: <https://skmtc.dev/vocadb/apis/vocadbweb/docs/api/users/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `query` string
- `groups` 'Nothing' | 'Limited' | 'Regular' | 'Trusted' | 'Moderator' | 'Admin'
- `joinDateAfter` string, date-time
- `joinDateBefore` string, date-time
- `nameMatchMode` 'Auto' | 'Partial' | 'StartsWith' | 'Exact' | 'Words'
- `start` integer
- `maxResults` integer
- `getTotalCount` boolean
- `sort` 'RegisterDate' | 'Name' | 'Group'
- `includeDisabled` boolean
- `onlyVerified` boolean
- `knowsLanguage` string
- `fields` 'None' | 'KnownLanguages' | 'MainPicture' | 'OldUsernames'

## Response `200`

Success

- UserForApiContractPartialFindResult
  - `items` UserForApiContract[], nullable
    - `active` boolean
    - `groupId` 'Nothing' | 'Limited' | 'Regular' | 'Trusted' | 'Moderator' | 'Admin'
    - `knownLanguages` UserKnownLanguageContract[], nullable
      - `cultureCode` string, nullable
      - `proficiency` 'Nothing' | 'Basics' | 'Intermediate' | 'Advanced' | 'Native'
    - `mainPicture` EntryThumbForApiContract
      - `mime` string, nullable
      - `name` string, nullable
      - `urlOriginal` string, nullable
      - `urlSmallThumb` string, nullable
      - `urlThumb` string, nullable
      - `urlTinyThumb` string, nullable
    - `memberSince` string, date-time
    - `oldUsernames` OldUsernameContract[], nullable
      - `date` string, date-time
      - `oldName` string, nullable
    - `verifiedArtist` boolean
    - `id` integer
    - `name` string, nullable
  - `term` string, nullable
  - `totalCount` integer

## Changes

- **2023-02-17** `a58e37404e87`: 3 info
  - added the optional property `items/items/mainPicture/name` to the response with the `200` status (media type: text/plain)
  - added the optional property `items/items/mainPicture/name` to the response with the `200` status (media type: application/json)
  - added the optional property `items/items/mainPicture/name` to the response with the `200` status (media type: text/json)

[Operation history](https://skmtc.dev/vocadb/apis/vocadbweb/changes/api/users/get.md)

---

[API](https://skmtc.dev/vocadb/apis/vocadbweb.md) - [All operations](https://skmtc.dev/vocadb/apis/vocadbweb/llms.txt) - [OpenAPI document](https://skmtc.dev/vocadb/apis/vocadbweb/revisions/d1328dfaa36f?raw)