GIgitguardian
Teams

List teams

Changed on

This endpoint allows you to list all the teams of your workspace.

The response contains the list of teams and a pagination cursor to retrieve the next page.

The teams are sorted by id.

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

get/v1/teams

Request

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

Query parameters

cursorstring

Pagination cursor.

per_pageinteger

Number of items to list per page.

is_globalboolean

Filter on/exclude the "All-incidents" team.

searchstring

Search teams based on their name and/or description.

linked_to_an_external_providerboolean

Filter on/exclude teams that are linked to an external provider.

Response

List teams

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