Teams

Retrieve an existing team.

If you are using a personal access token, you need to have an access level greater or equal to member.

get/v1/teams/{team_id}

Request

  • Base URL
    https://api.gitguardian.com
  • URL
    https://api.gitguardian.com/v1/teams/{team_id}
  • Auth
    HTTP bearer

Path parameters

team_idinteger required

The id of the team

Response

Team details

idinteger
namestring
descriptionstring nullable

team description.

is_globalboolean
gitguardian_urlstring
external_provider_idstring nullable

ID of the external provider associated to the team.

external_provider_typestring nullable

Type of the external provider associated to the team.

Example response

{
  "id": 3252,
  "name": "feature team A",
  "description": "Description of my team",
  "gitguardian_url": "https://dashboard.gitguardian.com/workspace/1/settings/user/teams/1",
  "external_provider_id": "123-456-7890",
  "external_provider_type": "okta"
}

Changes