Teams

List teams

Changed on

Returns all teams in the workspace organization

get/workspaces/{workspaceSlug}/team

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/team
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

Response

list of teams with their members and permissions

descriptionstring

Description of the team

hiddenboolean required

Whether the team is hidden from workspace activity

htmlUrlstring

URL to the team's page on the git provider

idinteger required

Unique identifier of the team

membershipCountinteger required

Total count of team memberships

namestring required

Name of the team

organizationstring

Organization the team belongs to

parentIdinteger

ID of the parent team, if this is a sub-team

privacy'SECRET' | 'VISIBLE'

Privacy level of the team (SECRET or VISIBLE)

repoPermissionCountinteger required

Count of repository permissions

slugstring required

Stable team key for URL filters

Example response

[
  {
    "labels": [
      {
        "color": "d73a4a"
      }
    ],
    "repositories": [
      {
        "labels": [
          {
            "color": "d73a4a"
          }
        ]
      }
    ]
  }
]

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$

  • 8f5f4417c4e5Revision changes
    • info

      added the required property / to the response with the status