DEVELOPERS

Loops API Docs

RESOURCE

Account

Represents a Loops account. Returned by account endpoints and embedded wherever an author or user is referenced. Serialized by AccountResource.

Fields

Field	Type	Description
`id`	string	Unique identifier for the account.
`name`	string	Display name shown on the profile. Falls back to the username when unset.
`avatar`	string	URL of the account avatar.
`username`	string	The account handle.
`is_owner`	boolean	Whether the authenticated user owns this account.
`local`	boolean	Whether the account is hosted on this instance.
`bio`nullable	string	Profile bio text.
`post_count`	integer	Number of posts published by the account.
`follower_count`	integer	Number of accounts following this account.
`following_count`	integer	Number of accounts this account follows.
`url`	string	Canonical profile URL.
`remote_url`nullable	string	Profile URL on the origin instance for remote accounts; null for local accounts.
`is_blocking`nullable	boolean	Whether the authenticated user is blocking this account. null when not applicable, e.g. your own account.
`manually_approves_followers`	boolean	Whether follow requests must be approved manually (private account).
`links`	array	Profile links. Each entry is a Link object (see below).
`has_playlists`	boolean	Whether the account has any playlists.
`is_admin`	boolean	Whether the account is an instance administrator.
`created_at`	string	ISO 8601 timestamp of account creation.
`likes_count`	integer	Total likes received on posts by this account.

Example

Account

{
  "data": {
    "id": "1",
    "name": "dansup",
    "avatar": "https://loopsusercontent.com/avatars/1/y6i8g7330.jpg",
    "username": "dansup",
    "is_owner": true,
    "local": true,
    "bio": "Currently building @pixelfed, @loops, @supapp, @fedidb, and more.",
    "post_count": 96,
    "follower_count": 3610,
    "following_count": 83,
    "url": "https://loops.video/@dansup",
    "remote_url": null,
    "is_blocking": null,
    "manually_approves_followers": false,
    "links": [
      {
        "url": "apps.apple.com/us/app/loops",
        "link": "https://loops.video/link/...",
        "is_verified": false
      },
      {
        "url": "joinloops.org/team",
        "link": "https://loops.video/link/...",
        "is_verified": false
      }
    ],
    "has_playlists": true,
    "is_admin": true,
    "created_at": "2024-06-06T10:20:02+00:00",
    "likes_count": 4361
  }
}

Link object

Each entry in the links array has this shape:

Field	Type	Description
`url`	string	The destination URL as entered by the account owner.
`link`	string	Loops redirect URL that wraps the destination for click-through.
`is_verified`	boolean	Whether the link has been verified as owned by the account.

Some fields are relative to the viewer.is_owner and is_blocking describe the relationship between the authenticated request and this account, so they change depending on who is asking.