List users

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "blocked": {
      "type": "boolean"
    },
    "count": {
      "type": "integer"
    },
    "search": {
      "type": "string"
    },
    "sort": {
      "type": "string",
      "enum": [
        "-id",
        "-username",
        "-createdAt"
      ]
    },
    "start": {
      "type": "integer"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "properties": {
      "account": {
        "type": "object"
      },
      "autoPlayNextVideo": {
        "type": "boolean",
        "description": "Automatically start playing the upcoming video after the currently playing video"
      },
      "autoPlayNextVideoPlaylist": {
        "type": "boolean",
        "description": "Automatically start playing the video on the playlist after the currently playing video"
      },
      "autoPlayVideo": {
        "type": "boolean",
        "description": "Automatically start playing the video on the watch page"
      },
      "blocked": {
        "type": "boolean"
      },
      "blockedReason": {
        "type": "string"
      },
      "createdAt": {
        "type": "string"
      },
      "email": {
        "type": "string",
        "format": "email",
        "description": "The user email"
      },
      "emailVerified": {
        "type": "boolean",
        "description": "Has the user confirmed their email address?"
      },
      "id": {
        "type": "object"
      },
      "lastLoginDate": {
        "type": "string",
        "format": "date-time"
      },
      "noAccountSetupWarningModal": {
        "type": "boolean"
      },
      "noInstanceConfigWarningModal": {
        "type": "boolean"
      },
      "noWelcomeModal": {
        "type": "boolean"
      },
      "nsfwPolicy": {
        "type": "string",
        "enum": [
          "display",
          "blur",
          "do_not_list"
        ]
      },
      "p2pEnabled": {
        "type": "boolean",
        "description": "Enable P2P in the player"
      },
      "pluginAuth": {
        "type": "string",
        "description": "Auth plugin to use to authenticate the user"
      },
      "role": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The user role (Admin = `0`, Moderator = `1`, User = `2`)",
            "enum": [
              0,
              1,
              2
            ]
          },
          "label": {
            "type": "string",
            "enum": [
              "User",
              "Moderator",
              "Administrator"
            ]
          }
        }
      },
      "theme": {
        "type": "string",
        "description": "Theme enabled by this user"
      },
      "username": {
        "type": "string",
        "description": "immutable name of the user, used to find or mention its actor"
      },
      "videoChannels": {
        "type": "array",
        "items": {
          "type": "object"
        }
      },
      "videoQuota": {
        "type": "integer",
        "description": "The user video quota in bytes"
      },
      "videoQuotaDaily": {
        "type": "integer",
        "description": "The user daily video quota in bytes"
      }
    }
  }
}