ClientService

List Teams

Lists Teams for a given Organization. Results can be filtered and optionally include user counts for each team. Supports pagination for large result sets.

get/v1alpha2/organizations/{organization}/teams

Request

  • Base URL: https://api.thirdfort.dev/client/api
  • URL: https://api.thirdfort.dev/client/api/v1alpha2/organizations/{organization}/teams
  • Auth: HTTP bearer

Path parameters

organizationstring required

The organization identifier of the resource path.

Query parameters

pageSizeinteger

Optional limit on the number of Teams to be returned. If not specified, the default is 10. Values above 100 are rejected with an invalid-argument error.

pageTokenstring

Optional pagination token, returned earlier via ListTeamsResponse.next_page_token.

filterstring

Only include resources that match this filter in the response. Filtering by the following fields is supported:

  • display_name
  • brand (the Brand resource name the team uses)
  • brand_display_name
  • feature_set (will match on feature sets enabled for the team)

Maximum length 2000 bytes (the limit is measured in UTF-8 bytes, not characters).

For more information, see FilterSyntax

view'TEAM_VIEW_UNSPECIFIED' | 'TEAM_VIEW_BASIC' | 'TEAM_VIEW_SUMMARY' | 'TEAM_VIEW_FULL' | 'TEAM_VIEW_NAME_ONLY'

Optional. Specifies which view of the Team resources to return. When unspecified, defaults to BASIC view which includes core team fields without expensive count computations or related resource queries.

Performance implications:

  • BASIC: Fast response, no additional queries
  • SUMMARY: Moderate performance impact due to user count queries
  • FULL: Slowest response due to counts plus role bindings and feature queries

Recommended usage:

  • BASIC: Team selection dropdowns, simple navigation

  • SUMMARY: Team lists showing user counts

  • FULL: Detailed team management and administration pages

  • TEAM_VIEW_UNSPECIFIED: Default value. When used, defaults to BASIC view. This ensures backward compatibility for clients not specifying a view.

  • TEAM_VIEW_BASIC: Basic view includes core team information without expensive computations. This view provides essential team data needed for most operations while avoiding performance overhead from count calculations and related resource queries.

Includes:

  • name: The unique resource identifier

  • display_name: Human-readable team name

  • brand: Associated brand resource name

  • description: Team description text

  • TEAM_VIEW_SUMMARY: Summary view includes basic information plus count data. This view is optimized for team listing interfaces where user counts are needed for display but detailed related resources are not required.

Includes:

  • All BASIC fields

  • user_count: Number of users assigned to this team

  • TEAM_VIEW_FULL: Full view includes all available team information including related resources. This view should be used when complete team context is required, such as for detailed team management operations or comprehensive team administration.

Includes:

  • All SUMMARY fields

  • role_bindings: Complete list of role assignments and permissions

  • feature_settings: Individual feature configurations

  • feature_set_settings: Feature set configurations

  • TEAM_VIEW_NAME_ONLY: Name-only view exposes just enough to identify a team, for callers who may see which team a resource belongs to but nothing more about it (e.g. cross-org secure-share viewers). It is a strict subset of BASIC.

Includes:

  • name: The unique resource identifier
  • display_name: Human-readable team name

Response

A successful response.

nextPageTokenstring

A token to retrieve the next page of results. Pass this value in ListTeamsRequest.page_token to retrieve the next page of results.

Changes