Sign in

v1

latestOpenAPI 3.0.0AGPLv3.02026-07-14186117194.3 KB
Video Channels

Get a video channel

get/api/v1/video-channels/{channelHandle}

Path parameters

channelHandlestring required
Example:my_username | my_username@example.com

The video channel handle

Response

successful operation

createdAtstring date-time
followersCountinteger

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

followingCountinteger

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

hoststring hostname

server on which the actor is resident

hostRedundancyAllowedboolean

whether this actor's host allows redundancy of its videos

idinteger
namestring

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

updatedAtstring date-time
urlstring url
descriptionstring
displayNamestring

editable name of the channel, displayed in its representations

isLocalboolean
supportstring

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

Example response

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