Sign in

v1

latestOpenAPI 3.0.0AGPLv3.02026-07-14186117194.3 KB
My User

Get my user information

get/api/v1/users/me

Response

successful operation

autoPlayNextVideoboolean

Automatically start playing the upcoming video after the currently playing video

autoPlayNextVideoPlaylistboolean

Automatically start playing the video on the playlist after the currently playing video

autoPlayVideoboolean

Automatically start playing the video on the watch page

blockedboolean
blockedReasonstring
createdAtstring
emailstring email

The user email

emailVerifiedboolean

Has the user confirmed their email address?

idinteger
lastLoginDatestring date-time
noAccountSetupWarningModalboolean
noInstanceConfigWarningModalboolean
noWelcomeModalboolean
nsfwPolicy'display' | 'blur' | 'do_not_list'
p2pEnabledboolean

Enable P2P in the player

pluginAuthstring

Auth plugin to use to authenticate the user

themestring

Theme enabled by this user

usernamestring

immutable name of the user, used to find or mention its actor

videoQuotainteger

The user video quota in bytes

videoQuotaDailyinteger

The user daily video quota in bytes

Example response

[
  {
    "account": {
      "id": 42,
      "name": "chocobozzz",
      "userId": 42
    },
    "id": 42,
    "role": {
      "id": 2
    },
    "username": "chocobozzz",
    "videoChannels": [
      {
        "id": 42,
        "name": "chocobozzz",
        "description": "Videos made with <3 by Framasoft",
        "displayName": "Videos of Framasoft",
        "ownerAccount": {
          "uuid": "9c9de5e8-0a1e-484a-b099-e80766180a6d"
        },
        "support": "Please support our work on https://soutenir.framasoft.org/en/ <3"
      }
    ],
    "videoQuota": -1,
    "videoQuotaDaily": -1
  }
]