PeerTube

List accounts

Live Test Server (live data - latest nightly version)

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

GET

/accounts

Accounts

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

[
    {
        "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,
        "id": 42,
        "name": "chocobozzz",
        "updatedAt": "2019-08-24T14:15:22Z",
        "url": "string",
        "description": "string",
        "displayName": "string",
        "userId": {}
    }
]

Request

Query Params

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

array of:

avatar

object

ActorImage

optional

createdAt

string <date-time>

optional

path

string

optional

updatedAt

string <date-time>

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

integer

optional

>= 1

Example:

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

updatedAt

string <date-time>

optional

url

string <url>

optional

description

string

optional

text or bio displayed on the account's profile

displayName

string

optional

editable name of the account, displayed in its representations

>= 3 characters<= 120 characters

userId

object

optional

object id for the user tied to this account

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

List my abuses

Get an account