Sign in
team management

List Team V2

Get a paginated list of teams with filtering and sorting options.

Parameters: user_id: Optional[str] Only return teams which this user belongs to organization_id: Optional[str] Only return teams which belong to this organization team_id: Optional[str] Filter teams by exact team_id match team_alias: Optional[str] Filter teams by partial team_alias match page: int The page number to return page_size: int The number of items per page sort_by: Optional[str] Column to sort by (e.g. 'team_id', 'team_alias', 'created_at') sort_order: str Sort order ('asc' or 'desc') status: Optional[str] Filter by status. Currently supports "deleted" to query deleted teams.

get/v2/team/list

Query parameters

user_idstring nullable

Only return teams which this 'user_id' belongs to

Only return teams which this 'user_id' belongs to

organization_idstring nullable

Only return teams which this 'organization_id' belongs to

Only return teams which this 'organization_id' belongs to

team_idstring nullable

Only return teams which this 'team_id' belongs to

Only return teams which this 'team_id' belongs to

team_aliasstring nullable

Only return teams which this 'team_alias' belongs to. Supports partial matching.

Only return teams which this 'team_alias' belongs to. Supports partial matching.

pageinteger

Page number for pagination

Page number for pagination

page_sizeinteger

Number of teams per page

Number of teams per page

sort_bystring nullable

Column to sort by (e.g. 'team_id', 'team_alias', 'created_at')

Column to sort by (e.g. 'team_id', 'team_alias', 'created_at')

sort_orderstring

Sort order ('asc' or 'desc')

Sort order ('asc' or 'desc')

statusstring nullable

Filter by status (e.g. 'deleted')

Filter by status (e.g. 'deleted')

Response

Successful Response

totalinteger required
pageinteger required
page_sizeinteger required
total_pagesinteger required

Changes

No recorded changes to this endpoint across all 1 revision of this API.