Sign in

v1

latestOpenAPI 3.0.0AGPLv3.02026-07-14186117194.3 KB
Accounts

Get an account

get/api/v1/accounts/{name}

Path parameters

namestring required
Example:chocobozzz | chocobozzz@example.org

The username or handle of the account

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

text or bio displayed on the account's profile

displayNamestring

editable name of the account, displayed in its representations

userIdinteger

Example response

{
  "id": 42,
  "name": "chocobozzz",
  "userId": 42
}