---
title: "Find Users"
method: GET
path: "/users/find"
tags: ["Users"]
---

# Find Users

`GET /users/find`

List of users filtered by username, email or custom fields.

Required scopes:
+ **read**

## Query parameters

- `username` string — Username to filter. Usernames start with the query will be returned.
- `custom_fields` object — Custom fields to filter. Example: **custom_fields[telegram]=telegramLogin**.
- `fields_include` string[]

## Response `200`

Successful Response.

- object
  - `users` RespUserModel[], required
    - `user_id` integer, required
    - `username` string, required
    - `username_html` string, required
    - `user_message_count` integer, required
    - `user_register_date` integer, required
    - `user_like_count` integer, required
    - `user_like2_count` integer, required
    - `contest_count` integer, required
    - `trophy_count` integer, required
    - `short_link` string, required
    - `custom_title` string, required
    - `is_banned` integer, required
    - `display_banner_id` integer, required
    - `display_icon_group_id` integer, required
    - `balance` string, required
    - `hold` string, required
    - `currency` string, required
    - `user_email` string, required
    - `user_unread_notification_count` integer, required
    - `user_unread_conversation_count` integer, required
    - `conv_welcome_message` string, required
    - `show_dob_dateshow_dob_date` integer
    - `show_dob_year` integer, required
    - `user_title` string, required
    - `user_deposit` integer, required
    - `user_is_valid` boolean, required
    - `user_is_verified` boolean, required
    - `user_is_followed` boolean, required
    - `user_last_seen_date` integer, required
    - `links` object, required
      - `permalink` string, required
      - `detail` string, required
      - `avatar` string, required
      - `avatar_big` string, required
      - `avatar_small` string, required
      - `followers` string, required
      - `followings` string, required
      - `ignore` string, required
      - `background_l` string, required
      - `background_m` string, required
      - `timeline` string, required
    - `permissions` object, required
      - `edit` boolean, required
      - `follow` boolean, required
      - `create_conversation` boolean, required
      - `ignore` boolean, required
      - `profile_post` boolean, required
    - `user_is_ignored` boolean, required
    - `user_is_visitor` boolean, required
    - `user_group_id` integer, required
    - `curator_titles` string[], required
    - `user_groups` object[], required
      - `user_group_id` integer, required
      - `user_group_title` string, required
      - `user_group_title_en` string, required
      - `user_group_banner_css_class` string, required
      - `user_group_banner_text` string, required
      - `user_group_banner_text_en` string, required
      - `display_group_selectable` boolean, required
      - `display_banner_selectable` boolean, required
      - `display_icon_selectable` boolean, required
      - `is_primary_group` boolean, required
      - `user_group_icon_class` string, required
    - `fields` object[], required
      - `id` string, required
      - `title` string, required
      - `description` string, required
      - `position` string, required
      - `is_required` boolean, required
      - `is_system` boolean, required
      - `value` string
      - `editable` boolean, required
      - `is_multi_choice` boolean, required
      - `choices` object[], required
        - `key` string, required
        - `value` string, required
      - `values` unknown[], required
        - unknown
    - `user_timezone_offset` integer, required
    - `user_external_authentications` object[], required
      - `provider` string, required
      - `provider_key` string, required
    - `self_permissions` object, required
      - `create_conversation` boolean, required
    - `edit_permissions` object, required
      - `password` boolean, required
      - `user_email` boolean, required
      - `username` boolean, required
      - `user_title` boolean, required
      - `short_link` boolean, required
      - `hide_username_logs` boolean, required
      - `primary_group_id` boolean, required
      - `secondary_group_ids` boolean, required
      - `user_dob_day` boolean, required
      - `user_dob_month` boolean, required
      - `user_dob_year` boolean, required
      - `fields` boolean, required
    - `birthday` object, nullable, required
      - `age` integer, required
      - `timeStamp` object, required
        - `date` string, required
        - `timezone_type` integer, required
        - `timezone` string, required
      - `format` string, required
    - `secret_answer_rendered` string, required
    - `secret_answer_first_letter` string, required
    - `user_following` object, required
      - `users` object[], required
        - `user_id` integer, required
        - `username` string, required
        - `username_html` string, required
        - `avatar` string, required
      - `count` integer, required
    - `user_followers` object, required
      - `users` object[], required
        - `user_id` integer, required
        - `username` string, required
        - `username_html` string, required
        - `avatar` string, required
      - `count` integer, required
    - `profile_threads` object[], required
      - `thread_id` integer, required
      - `forum_id` integer, required
      - `thread_title` string, required
      - `thread_view_count` integer, required
      - `creator_user_id` integer, required
      - `creator_username` string, required
      - `creator_username_html` string, required
      - `thread_create_date` integer, required
      - `thread_update_date` integer, required
      - `thread_reply_group_id` integer, required
      - `thread_comment_ignore_group` integer, required
      - `thread_last_bump_date` integer, required
      - `thread_hide_contacts` integer, required
      - `thread_allow_ask_hidden_content` integer, required
      - `user_is_ignored` boolean, required
      - `thread_post_count` integer, required
      - `thread_is_bumped` boolean, required
      - `thread_is_published` boolean, required
      - `thread_is_deleted` boolean, required
      - `thread_is_sticky` boolean, required
      - `thread_is_closed` boolean, required
      - `thread_is_followed` boolean, required
      - `thread_is_starred` boolean, required
      - `thread_prefixes` unknown[], required
        - unknown
      - `thread_tags` object, required
        - `38` string, required
        - `523` string, required
        - `1403` string, required
        - `1953` string, required
        - `8176` string, required
      - `links` object, required
        - `permalink` string, required
        - `detail` string, required
        - `followers` string, required
        - `forum` string, required
        - `posts` string, required
        - `first_poster` string, required
        - `first_poster_avatar` string, required
        - `first_post` string, required
        - `last_post` string, required
      - `permissions` object, required
        - `view` boolean, required
        - `delete` boolean, required
        - `follow` boolean, required
        - `post` boolean, required
        - `bump` object, required
          - `can` boolean, required
          - `available_count` integer, required
          - `error` unknown, required
          - `next_available_time` unknown, required
      - `node_title` string, required
    - `banner` string, required
  - `system_info` RespSystemInfo, required
    - `visitor_id` integer, required
    - `time` integer, required
    - `log_id` integer, required

## Other responses

- `401` — Unauthorized
- `403` — Error Response.

---

[API](https://skmtc.net/lolz/apis/lolzteam-public-api-forum.md) · [All operations](https://skmtc.net/lolz/apis/lolzteam-public-api-forum/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lolz/lolzteam-public-api-forum/versions/3efcdbc40994/schema)