Skip to content

List a team's members

GET
/teams/{id}/members

Returns a team’s direct members, newest first. Roles, follows and membership of teams below it don’t put anyone on this list on their own.

You need to be signed in with teams.read granted globally; others get 403. Without a session cookie or bearer token that identifies you, the answer is 401, whether or not public mode is on. An id that isn’t a UUID gets a plain-text 400 before sign-in is checked.

The team isn’t looked up, so an id with no team gives an empty list, and a deleted team still lists its members. Members added at the same moment come by user_ref, and there’s no paging.

Only memberships whose account still exists are listed, so the list can be shorter than the team’s member_count in listTeams; accounts are listed whatever their status. Anyone who can call this sees each member’s username and display name where they have one, and the ref of whoever added them where it was recorded. Server errors get a plain-text 500.

id
required
string format: uuid

The team’s id.

The team’s direct members, newest first.

Array<object>
object
team_id
required

The team’s id.

string format: uuid
user_ref
required

The member’s account ref.

integer format: int64
added_at
required

When the membership was first added. Adding the member again doesn’t change it.

string format: date-time
added_by_user_ref

The ref of whoever added the member. Left out when not recorded.

integer format: int64
nullable
username

The member’s username. Left out if the account has none.

string
display_name

The member’s profile display name. Left out when they have no profile or it’s empty; fall back to username.

string
nullable

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