PeerTube

List video channels of an account

Live Test Server (live data - latest nightly version)

https://peertube2.cpy.re/api/v1

GET

/accounts/{name}/video-channels

Video ChannelsAccounts

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://peertube2.cpy.re/api/v1/accounts//video-channels'

Response Example

{
    "data": [
        {
            "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",
            "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,
            "name": "chocobozzz",
            "url": "string"
        }
    ],
    "total": 1
}

Request

Path Params

name

string

required

The username or handle of the account

Query Params

withStats

string

optional

include view statistics for the last 30 days (only if authentified as the account user)

start

integer

optional

Offset used to paginate results

count

integer

optional

Number of items to return

sort

string

optional

Sort column

Responses

🟢200successful operation

application/json

Body

data

array[object (Actor) {15}]

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

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

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._]+$/

url

string <url>

optional

total

integer

optional

Example:

Modified at 2022-09-10 22:29:49

List videos of an account

List video channels