v1

latestOpenAPI 3.0.0AGPLv3.02026-07-14186117194.3 KB
Users

Get a user

get/api/v1/users/{id}

Query parameters

withStatsboolean

include statistics about the user (only available as a moderator/admin)

Response

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.

OR

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
}