Skip to main content
GET
List the member's Team

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company. A member session JWT, the kind order and subscription email links carry, is refused with 403, as legacy My Team needs a rep session. A customer or preferred-customer membership is refused with 403 too: legacy My Team (authorize_rep_tier) admits reps, company admins and root admins. A company admin's own credential is not a member credential and gets 401, so in practice a rep's or a root admin's membership reads the Team.

Headers

If-None-Match
string

A previously returned ETag. Authentication and the current Team read run before a 304 is considered.

Query Parameters

filter[under]
string<uuid>

A Team member's id to page beneath. A member outside the signed-in member's downline returns 404, and so does one the enrollment tree does not place below the signed-in member in a company on tree reads.

filter[depth]
integer
default:1

Levels below the signed-in member, or below filter[under], to include.

Required range: 1 <= x <= 5
page[cursor]
string

Opaque cursor from meta.pagination.next_cursor, valid only with the same filters and member. A malformed, tampered or mismatched cursor returns 400.

page[limit]
integer
default:25

Page size. Defaults to 25, at most 100.

Required range: 1 <= x <= 100

Response

A page of the member's current Team.

A page of Team members.

status
integer
required
data
object[]
required

Team members, nearest level first, then by join time and member id.

meta
object
required

Envelope metadata present on every response.