ClientService

Get Team

Returns the requested Team by its resource name. Optionally includes user counts and role bindings associated with the team.

get/v1alpha2/organizations/{organization}/teams/{team}

Request

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

Path parameters

organizationstring required

The organization identifier of the resource path.

teamstring required

The team identifier of the resource path.

Query parameters

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

Optional. Specifies which view of the Team resource 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 query
  • FULL: Slowest response due to counts plus role bindings and feature queries

Use BASIC for navigation, SUMMARY for dashboards, FULL for team management.

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

namestring
displayNamestring required
brandstring required

The name of the Brand for this Team.

descriptionstring

Human readable description of the Team.

userCountinteger

Count of Users for this Team if requested. Always 0 for a soft-deleted Team: deleting a team removes its role bindings.

deleteTimestring date-time

The time at which the Team was soft-deleted. Unset for a live team. A soft-deleted team is returned by GetTeam and BatchGetTeams but is excluded from ListTeams, and is never undeleted or purged.

Its user_count, role_bindings, feature_settings and feature_set_settings are always 0 or empty, because deleting a team removes them — treat all four as unknown for a deleted team rather than as a team that genuinely had none. In particular, an empty feature_settings does not mean the team had no features; it means the answer is no longer recoverable, so do not derive entitlement from it.

Changes

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