---
title: "Returns paginated list of users"
method: GET
path: "/v1/users"
tags: ["Users"]
---

# Returns paginated list of users

`GET /v1/users`

## Request

- Base URL: `https://api.momentum-mod.org` (the document declares no server; this is the origin it was published from)
- URL: `https://api.momentum-mod.org/v1/users`
- Auth: HTTP bearer

## Query parameters

- `skip` number
- `take` number
- `expand` 'profile' | 'userStats'
- `search` string
- `steamID` string
- `steamIDs` string
- `userIDs` string

## Response `200`

- object: Paginated list of users
  - `totalCount` number, required: The total number of results found
  - `returnCount` number, required: The number of results in the response
  - `data` array[], required: Array of the response type found
    - unknown[]
      - unknown
  - `response` UserDto[]
    - `id` number, required: The unique numeric ID of the user
    - `steamID` string, required: The Steam community ID (i.e. the uint64 format, not STEAM:...) of the user
    - `alias` string, required: The user's alias, which is either a current or previous Steam name, or something they set themselves
    - `country` string: Two-letter (ISO 3166-1 Alpha-2) country code for the user
    - `avatarURL` string, required
    - `profile` ProfileDto
      - `userID` number, required: The ID of the user
      - `bio` string, required: The text-based bio of the user
      - `socials` SocialsDto
        - `Discord` string, required: Discord Username
        - `Github` string, required: Github Username
        - `Instagram` string, required: Instagram Username
        - `Ko-fi` string, required: Ko-fi Username
        - `LinkedIn` string, required: LinkedIn Username
        - `Mastodon` string, required: Mastodon Username
        - `Patreon` string, required: Patreon Username
        - `Paypal` string, required: Paypal Username
        - `Spotify` string, required: Spotify Username
        - `Twitch` string, required: Twitch Username
        - `Twitter` string, required: Twitter Username
        - `YouTube` string, required: YouTube Username
    - `userStats` UserStatsDto
      - `cosXP` number, required: The user's total cosmetic XP
      - `level` number, required: The user's level
      - `mapsCompleted` number, required: Total maps completed
      - `runsSubmitted` number, required: Total runs submitted
      - `totalJumps` number, required: The user's total number of jumps
      - `totalStrafes` number, required: The user's total number of strafes
    - `roles` number, required: Flags of user's roles
    - `bans` number, required: Flags of user's bans
    - `createdAt` string, required: When the item was first created, as ISO8601 date string

## Other responses

- `400`: The query contained conflicting parameters

---

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