Skip to content

Get a team

GET
/teams/{id}

Returns one team with its direct parents.

You need to be signed in with teams.read granted globally; others get 403. A deleted team, or an id with no team, normally gets 404. An id that isn’t a UUID gets a plain-text 400 before sign-in is checked, and server errors get a plain-text 500.

The server keeps recently read teams in memory. A change to the team itself clears its copy, but a parent’s rename or deletion doesn’t, so the parent can still show as it was until the team is next read fresh, and in rare cases a read that overlaps a change keeps the older copy, even of a team that was just deleted. The picture is checked fresh every time. The counts aren’t included; listTeams has them.

id
required
string format: uuid

The team’s id.

The team, with its direct parents.

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

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed