ClientService

Batch Get Teams

Returns the requested set of Teams by name. All names must be in the Organization specified by parent. Maximum of 100 teams can be retrieved per request.

get/v1alpha2/organizations/{organization}/teams:batchGet

Request

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

Path parameters

organizationstring required

The organization identifier of the resource path.

Query parameters

namesstring[] required

The names of the Team to get. Must contain between 1 and 100 names; an empty list or more than 100 is rejected.

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 per team
  • SUMMARY: Moderate performance impact due to user count queries
  • FULL: Slowest response due to counts plus role bindings and feature queries

Use BASIC for most batch operations, SUMMARY/FULL when additional data is needed.

  • 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.

Changes

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