PeerTube
  1. Users
PeerTube
  • Abuses
    • List abuses
      GET
    • Report an abuse
      POST
    • Delete an abuse
      DELETE
    • Update an abuse
      PUT
    • List messages of an abuse
      GET
    • Add message to an abuse
      POST
    • Delete an abuse message
      DELETE
    • List my abuses
      GET
  • Accounts
    • List accounts
      GET
    • Get an account
      GET
    • List ratings of an account
      GET
    • List videos of an account
      GET
  • Video Channels
    • List video channels of an account
      GET
    • List video channels
      GET
    • Create a video channel
      POST
    • Delete a video channel
      DELETE
    • Get a video channel
      GET
    • Update a video channel
      PUT
    • Delete channel avatar
      DELETE
    • Update channel avatar
      POST
    • Delete channel banner
      DELETE
    • Update channel banner
      POST
  • Config
    • Get instance public configuration
    • Get instance "About" information
    • Delete instance runtime configuration
    • Get instance runtime configuration
    • Set instance runtime configuration
  • Homepage
    • Get instance custom homepage
    • Set instance custom homepage
  • Feeds
    • List videos of subscriptions tied to a token
    • List comments on videos
    • List videos
  • Job
    • List instance jobs
  • Session
    • Login prerequisite
    • Logout
    • Login
  • Plugins
    • List plugins
    • List available plugins
    • Install a plugin
    • Uninstall a plugin
    • Update a plugin
    • Get a plugin
    • Get a plugin's public settings
    • Get a plugin's registered settings
    • Set a plugin's settings
  • Search
    • Search channels
    • Search playlists
    • Search videos
  • Account Blocks
    • List account blocks
    • Block an account
    • Unblock an account by its handle
  • Server Blocks
    • List server blocks
    • Block a server
    • Unblock a server by its domain
  • Instance Follows
    • List instances following the server
    • Remove or reject a follower to your server
    • Accept a pending follower to your server
    • Reject a pending follower to your server
    • List instances followed by the server
    • Follow a list of actors (PeerTube instance, channel or account)
    • Unfollow an actor (PeerTube instance, channel or account)
  • Video Mirroring
    • List videos being mirrored
    • Mirror a video
    • Delete a mirror done on a video
  • Instance Redundancy
    • Update a server redundancy policy
  • Users
    • List users
      GET
    • Create a user
      POST
    • Resend user verification link
      POST
    • Register a user
      POST
    • Delete a user
      DELETE
    • Get a user
      GET
    • Update a user
      PUT
    • Verify a user
      POST
  • My User
    • Get my user information
    • Update my user information
    • Delete my avatar
    • Update my user avatar
    • Get my user used quota
    • Get videos of my user
    • Get rate of my user for a video
  • My History
    • List watched videos history
    • Clear video history
  • My Notifications
    • Update my notification settings
    • List my notifications
    • Mark notifications as read by their id
    • Mark all my notification as read
  • My Subscriptions
    • Get my user subscriptions
    • Add subscription to my user
    • Get if subscriptions exist for my user
    • List videos of subscriptions of my user
    • Delete subscription of my user
    • Get subscription of my user
  • Video Playlists
    • Check video exists in my playlists
    • List video playlists
    • Create a video playlist
    • List available playlist privacy policies
    • Delete a video playlist
    • Get a video playlist
    • Update a video playlist
    • Reorder a playlist
    • Delete an element from a playlist
    • Update a playlist element
  • Videos
    • Get video imports of my user
    • List videos of a playlist
    • Add a video in a playlist
  • Video
    • List videos of a video channel
    • List videos
    • List available video categories
    • Import a video
    • List available video languages
    • List available video licences
    • List available video privacy policies
    • Upload a video
    • Cancel the resumable upload of a video, deleting any data uploaded so far
    • Initialize the resumable upload of a video
    • Send chunk for the resumable upload of a video
    • Delete a video
    • Get a video
    • Update a video
    • Get complete video description
    • Add a view to a video
    • Set watching progress of a video
  • Video Blocks
    • List video blocks
    • Unblock a video by its id
    • Block a video
  • Live Videos
    • Create a live
    • Get information about a live
    • Update information about a live
  • Video Ownership Change
    • List video ownership changes
    • Accept ownership change request
    • Refuse ownership change request
    • Request ownership change
  • Video Captions
    • List captions of a video
    • Delete a video caption
    • Add or replace a video caption
  • Video Comments
    • List threads of a video
    • Create a thread
    • Get a thread
    • Delete a comment or a reply
    • Reply to a thread of a video
  • Video Rates
    • Like/dislike a video
  1. Users

Get a user

Live Test Server (live data - latest nightly version)
https://peertube2.cpy.re/api/v1
Live Test Server (live data - latest nightly version)
https://peertube2.cpy.re/api/v1
GET
/users/{id}
Users
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://peertube2.cpy.re/api/v1/users/'
Response Response Example
{
    "account": {
        "avatar": {
            "createdAt": "2019-08-24T14:15:22Z",
            "path": "string",
            "updatedAt": "2019-08-24T14:15:22Z"
        },
        "createdAt": "2019-08-24T14:15:22Z",
        "followersCount": 0,
        "followingCount": 0,
        "host": "example.com",
        "hostRedundancyAllowed": true,
        "id": 42,
        "name": "chocobozzz",
        "updatedAt": "2019-08-24T14:15:22Z",
        "url": "string",
        "description": "string",
        "displayName": "string",
        "userId": {}
    },
    "autoPlayNextVideo": true,
    "autoPlayNextVideoPlaylist": true,
    "autoPlayVideo": true,
    "blocked": true,
    "blockedReason": "string",
    "createdAt": "string",
    "email": "user@example.com",
    "emailVerified": true,
    "id": 42,
    "lastLoginDate": "2019-08-24T14:15:22Z",
    "noInstanceConfigWarningModal": true,
    "noWelcomeModal": true,
    "nsfwPolicy": "display",
    "pluginAuth": "string",
    "role": 2,
    "roleLabel": "User",
    "theme": "string",
    "username": "chocobozzz",
    "videoChannels": [
        {
            "description": "Videos made with <3 by Framasoft",
            "displayName": "Videos of Framasoft",
            "id": 42,
            "isLocal": true,
            "ownerAccount": {
                "id": 0,
                "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d"
            },
            "support": "Please support our work on https://soutenir.framasoft.org/en/ <3",
            "updatedAt": "2019-08-24T14:15:22Z"
        }
    ],
    "videoQuota": -1,
    "videoQuotaDaily": -1,
    "webtorrentEnabled": true
}

Request

Path Params
id
string 
required
Query Params
withStats
string 
optional
include statistics about the user (only available as a moderator/admin)

Responses

🟢200As 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.
application/json
Body
optional
One of
account
object (Account) 
optional
autoPlayNextVideo
boolean 
optional
Automatically start playing the upcoming video after the currently playing video
autoPlayNextVideoPlaylist
boolean 
optional
Automatically start playing the video on the playlist after the currently playing video
autoPlayVideo
boolean 
optional
Automatically start playing the video on the watch page
blocked
boolean 
optional
blockedReason
string 
optional
createdAt
string 
optional
email
string <email>
optional
The user email
emailVerified
boolean 
optional
Has the user confirmed their email address?
id
integer 
read-onlyoptional
>= 1
Example:
42
lastLoginDate
string <date-time>
optional
noInstanceConfigWarningModal
boolean 
optional
noWelcomeModal
boolean 
optional
nsfwPolicy
enum<string> 
optional
Allowed values:
displayblurdo_not_list
pluginAuth
string 
optional
Auth plugin to use to authenticate the user
role
enum<integer> 
optional
The user role (Admin = 0, Moderator = 1, User = 2)
Allowed values:
012
Example:
2
roleLabel
enum<string> 
optional
Allowed values:
UserModeratorAdministrator
theme
string 
optional
Theme enabled by this user
username
string 
optional
immutable name of the user, used to find or mention its actor
>= 1 characters<= 50 characters
Example:
chocobozzz
Match pattern:
/^[a-z0-9._]+$/
videoChannels
array[object (VideoChannel) {7}] 
optional
videoQuota
integer 
optional
The user video quota in bytes
Example:
-1
videoQuotaDaily
integer 
optional
The user daily video quota in bytes
Example:
-1
webtorrentEnabled
boolean 
optional
Enable P2P in the player
Modified at 2022-09-10 22:29:49
Previous
Delete a user
Next
Update a user
Built with