---
title: "Get a user"
method: GET
path: "/api/v1/users/{id}"
tags: ["Users"]
---

# Get a user

`GET /api/v1/users/{id}`

## Query parameters

- `withStats` boolean

## Response `200`

As an admin/moderator, you can request a response augmented with statistics about the user's
moderation relations and videos usage, by using the `withStats` parameter.

- union
  - User
    - `account` Account
      - `createdAt` string, date-time
      - `followersCount` integer — number of followers of this actor, as seen by this instance
      - `followingCount` integer — number of actors subscribed to by this actor, as seen by this instance
      - `host` string, hostname — server on which the actor is resident
      - `hostRedundancyAllowed` boolean — whether this actor's host allows redundancy of its videos
      - `id` integer
      - `name` string — immutable name of the user, used to find or mention its actor
      - `updatedAt` string, date-time
      - `url` string, url
      - `description` string — text or bio displayed on the account's profile
      - `displayName` string — editable name of the account, displayed in its representations
      - `userId` integer
    - `autoPlayNextVideo` boolean — Automatically start playing the upcoming video after the currently playing video
    - `autoPlayNextVideoPlaylist` boolean — Automatically start playing the video on the playlist after the currently playing video
    - `autoPlayVideo` boolean — Automatically start playing the video on the watch page
    - `blocked` boolean
    - `blockedReason` string
    - `createdAt` string
    - `email` string, email — The user email
    - `emailVerified` boolean — Has the user confirmed their email address?
    - `id` integer
    - `lastLoginDate` string, date-time
    - `noAccountSetupWarningModal` boolean
    - `noInstanceConfigWarningModal` boolean
    - `noWelcomeModal` boolean
    - `nsfwPolicy` 'display' | 'blur' | 'do_not_list'
    - `p2pEnabled` boolean — Enable P2P in the player
    - `pluginAuth` string — Auth plugin to use to authenticate the user
    - `role` object
      - `id` 0 | 1 | 2 — The user role (Admin = `0`, Moderator = `1`, User = `2`)
      - `label` 'User' | 'Moderator' | 'Administrator'
    - `theme` string — Theme enabled by this user
    - `username` string — immutable name of the user, used to find or mention its actor
    - `videoChannels` VideoChannel[]
      - `createdAt` string, date-time
      - `followersCount` integer — number of followers of this actor, as seen by this instance
      - `followingCount` integer — number of actors subscribed to by this actor, as seen by this instance
      - `host` string, hostname — server on which the actor is resident
      - `hostRedundancyAllowed` boolean — whether this actor's host allows redundancy of its videos
      - `id` integer
      - `name` string — immutable name of the user, used to find or mention its actor
      - `updatedAt` string, date-time
      - `url` string, url
      - `banners` ActorImage[]
        - `createdAt` string, date-time
        - `path` string
        - `updatedAt` string, date-time
        - `width` integer
      - `description` string
      - `displayName` string — editable name of the channel, displayed in its representations
      - `isLocal` boolean
      - `ownerAccount` object, nullable
        - `id` integer
        - `uuid` string, uuid
      - `support` string — text shown by default on all videos of this channel, to tell the audience how to support it
    - `videoQuota` integer — The user video quota in bytes
    - `videoQuotaDaily` integer — The user daily video quota in bytes
  - UserWithStats
    - `account` Account
      - `createdAt` string, date-time
      - `followersCount` integer — number of followers of this actor, as seen by this instance
      - `followingCount` integer — number of actors subscribed to by this actor, as seen by this instance
      - `host` string, hostname — server on which the actor is resident
      - `hostRedundancyAllowed` boolean — whether this actor's host allows redundancy of its videos
      - `id` integer
      - `name` string — immutable name of the user, used to find or mention its actor
      - `updatedAt` string, date-time
      - `url` string, url
      - `description` string — text or bio displayed on the account's profile
      - `displayName` string — editable name of the account, displayed in its representations
      - `userId` integer
    - `autoPlayNextVideo` boolean — Automatically start playing the upcoming video after the currently playing video
    - `autoPlayNextVideoPlaylist` boolean — Automatically start playing the video on the playlist after the currently playing video
    - `autoPlayVideo` boolean — Automatically start playing the video on the watch page
    - `blocked` boolean
    - `blockedReason` string
    - `createdAt` string
    - `email` string, email — The user email
    - `emailVerified` boolean — Has the user confirmed their email address?
    - `id` integer
    - `lastLoginDate` string, date-time
    - `noAccountSetupWarningModal` boolean
    - `noInstanceConfigWarningModal` boolean
    - `noWelcomeModal` boolean
    - `nsfwPolicy` 'display' | 'blur' | 'do_not_list'
    - `p2pEnabled` boolean — Enable P2P in the player
    - `pluginAuth` string — Auth plugin to use to authenticate the user
    - `role` object
      - `id` 0 | 1 | 2 — The user role (Admin = `0`, Moderator = `1`, User = `2`)
      - `label` 'User' | 'Moderator' | 'Administrator'
    - `theme` string — Theme enabled by this user
    - `username` string — immutable name of the user, used to find or mention its actor
    - `videoChannels` VideoChannel[]
      - `createdAt` string, date-time
      - `followersCount` integer — number of followers of this actor, as seen by this instance
      - `followingCount` integer — number of actors subscribed to by this actor, as seen by this instance
      - `host` string, hostname — server on which the actor is resident
      - `hostRedundancyAllowed` boolean — whether this actor's host allows redundancy of its videos
      - `id` integer
      - `name` string — immutable name of the user, used to find or mention its actor
      - `updatedAt` string, date-time
      - `url` string, url
      - `banners` ActorImage[]
        - `createdAt` string, date-time
        - `path` string
        - `updatedAt` string, date-time
        - `width` integer
      - `description` string
      - `displayName` string — editable name of the channel, displayed in its representations
      - `isLocal` boolean
      - `ownerAccount` object, nullable
        - `id` integer
        - `uuid` string, uuid
      - `support` string — text shown by default on all videos of this channel, to tell the audience how to support it
    - `videoQuota` integer — The user video quota in bytes
    - `videoQuotaDaily` integer — The user daily video quota in bytes
    - `abusesAcceptedCount` integer — Count of reports/abuses created by the user and accepted/acted upon by the moderation team
    - `abusesCount` integer — Count of reports/abuses of which the user is a target
    - `abusesCreatedCount` integer — Count of reports/abuses created by the user
    - `videoCommentsCount` integer — Count of comments published
    - `videosCount` integer — Count of videos published

---

[API](https://skmtc.net/cpy/apis/peertube.md) · [All operations](https://skmtc.net/cpy/apis/peertube/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpy/peertube/versions/efe11b159e43/schema)