List users - PeerTube

[ { "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

Query Params

string

optional

Plain text search that will match with user usernames or emails

blocked

string

optional

Filter results down to (un)banned users

start

integer

optional

Offset used to paginate results

count

integer

optional

Number of items to return

sort

string

optional

Sort users by criteria

Responses

🟢200successful operation

application/json

Body

array of:

account

object (Account)

optional

avatar

object

ActorImage

optional

createdAt

string <date-time>

optional

followersCount

integer

optional

number of followers of this actor, as seen by this instance

>= 0

followingCount

integer

optional

number of actors subscribed to by this actor, as seen by this instance

>= 0

host

string <hostname>

optional

server on which the actor is resident

hostRedundancyAllowed

boolean

optional

whether this actor's host allows redundancy of its videos

integer

optional

>= 1

Example:

name

string

optional

immutable name of the actor, used to find or mention it

>= 1 characters<= 50 characters

Example:

chocobozzz

Match pattern:

/^[a-z0-9._]+$/

updatedAt

string <date-time>

optional

url

string <url>

optional

description

string

optional

text or bio displayed on the account's profile

displayName

string

optional

editable name of the account, displayed in its representations

>= 3 characters<= 120 characters

userId

object

optional

object id for the user tied to this account

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

string <email>

optional

The user email

emailVerified

boolean

optional

Has the user confirmed their email address?

integer

read-onlyoptional

>= 1

Example:

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:

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

description

string

optional

>= 3 characters<= 1000 characters

Example:

Videos made with <3 by Framasoft

displayName

string

optional

editable name of the channel, displayed in its representations

>= 1 characters<= 120 characters

Example:

Videos of Framasoft

integer

read-onlyoptional

>= 1

Example:

isLocal

boolean

read-onlyoptional

ownerAccount

object | null

read-onlyoptional

support

string

optional

text shown by default on all videos of this channel, to tell the audience how to support it

>= 3 characters<= 1000 characters

Example:

Please support our work on https://soutenir.framasoft.org/en/ <3

updatedAt

string <date-time>

read-onlyoptional

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