Accounts

Get an account

GET

https://peertube2.cpy.re/api/v1/accounts/{name}

Get an account

curl -X GET 'https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org'

const response = await fetch('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org', {
  method: 'GET',
});

const data = await response.text();

import requests

response = requests.get('https://peertube2.cpy.re/api/v1/accounts/chocobozzz%20%7C%20chocobozzz%40example.org')
print(response.text)

200

{
  "id": 42,
  "url": "https://example.com",
  "avatars": [
    {
      "path": "string",
      "fileUrl": "string",
      "width": 0,
      "height": 0,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "host": "example.com",
  "hostRedundancyAllowed": true,
  "followingCount": 0,
  "followersCount": 0,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "displayName": "string",
  "description": "string"
}

Parameters

namestringrequiredpath

The username or handle of the account

Response

200OKActor & any

successful operation

Response fields application/json

idid>= 1

Example

urlstring<url>

nameusername

immutable name of the actor, used to find or mention it

Show child attributes

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

username

Example

chocobozzz

avatarsArray<ActorImage>

Show child attributes

pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger

heightinteger

PeerTube >= 7.3

createdAtstring<date-time>

updatedAtstring<date-time>

hoststring<hostname>

server on which the actor is resident

hostRedundancyAllowedboolean | null

whether this actor's host allows redundancy of its videos

followingCountinteger>= 0

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

followersCountinteger>= 0

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

createdAtstring<date-time>

updatedAtstring<date-time>

userIdid | null

object id for the user tied to this account

Show child attributes

id>= 1

Example

displayNamestring

editable name of the account, displayed in its representations

descriptionstring | null

text or bio displayed on the account's profile

404Not Found

account not found

Docs by Sourcey