ClientService

List Teams

Lists Teams within the specified organization. Results are paginated and can be filtered. Deleted teams are not returned.

get/v1/organizations/{organization}/teams

Request

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

Path parameters

organizationstring required

The organization identifier of the resource path.

Query parameters

pageSizeinteger

Optional. The maximum number of teams to return per page. If not specified, a default value of 10 will be used. Maximum allowed value is 100; larger values are rejected with an invalid-argument error.

pageTokenstring

Optional. A page token, received from a previous ListTeams call. Provide this token to retrieve the subsequent page. When not provided, returns the first page of results.

filterstring

Optional. Filter expression to limit the teams returned in the response. Filtering by the following fields is supported:

  • display_name
  • brand: the resource name of the Brand the team uses
  • brand_display_name

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

For more information, see FilterSyntax

Response

A successful response.

nextPageTokenstring

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent request to retrieve the next page. This field will be empty if there are no more results to retrieve.

Changes

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