Skip to content

Read featured teams

GET
/featured/teams

Returns up to 24 operator-curated teams in display order.

You need global teams.read or system.admin for the whole install; a permission held only for a team doesn’t count. Without one you get 403, and signed-out callers get 401, whether or not public mode is on.

The query admits both org and public team placements and drops missing or soft-deleted teams. Teams currently have no further per-team visibility rule. Results are sorted by placement position, then creation time, with no further tie-breaker. There’s no pagination or total count, and with no placements you get []. Different placements can name the same team.

Each team’s hero is checked in a separate read. The hero asset must still belong to that team, be public and not soft-deleted, have a file hash and a col variant record, and pass the mature-content check. Otherwise hero_asset_id is left out so clients can show initials. A failed hero lookup fails the request. The lookup doesn’t check the underlying bytes or every condition the asset-serving endpoint applies later.

Each entry has the basic team fields and the resolved hero. Parent links, member counts and content counts aren’t filled in. The team list and the hero lookup aren’t one atomic snapshot, so concurrent changes can show up between them.

Featured teams in curation order, or an empty array.

Array<object>
object
id
required
string format: uuid
slug
required

The team’s short name, unique among this server’s teams. A deleted team keeps its slug.

string
<= 80 characters
Example
aurora-rnd
name
required
string
<= 200 characters
Example
Aurora R&D
description
required
string
<= 500 characters
origin_server_id

The server a copied team came from. Left out for this server’s own teams; nothing in the API creates copies.

string format: uuid
nullable
hero_asset_id

The team’s picture: fetch it from /assets/{hero_asset_id}/variants/col. Left out when the team has no picture you can see, and then clients show the team’s initials.

This is checked on every read, for the person asking. The chosen asset must still be public, filed under the team and not deleted, with a col preview on record for its file; if it’s rated mature, the viewer must own it, have mature content turned on where the instance allows it, or have system.admin. The choice is kept when the picture stops qualifying, so it comes back when it qualifies again. It isn’t shared with other servers.

string format: uuid
nullable
parents

The team’s direct parents. Sent when one team is returned (an empty list if it has none) and left out of lists. Deleted parents aren’t included, though a parent renamed or deleted since the team last changed can still show as it was.

Array<object>
object
parent_id
required
string format: uuid
parent_slug
string
parent_name
string
member_count

How many direct memberships the team has; members of teams below it aren’t counted. Only listTeams sends it.

integer format: int64
content_count

How many assets filed under the team haven’t been deleted. Every one counts, including drafts and assets you can’t open or that are hidden from you as mature, so it can be higher than what the team’s asset list shows you. Posts and collections aren’t counted. Only listTeams sends it.

integer format: int64
created_at
required
string format: date-time
updated_at
required
string format: date-time

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed