Teams API?

[Mick Szucs]

Is there any update on when we can expect the addition of a Teams API endpoint?

Thanks!

[April Chi]

Hey @Mick Szucs ,

Thanks for joining the group and appreciate the question! We have public Teams API endpoints available today, they're documented here.

What's your use case? Are you looking for anything specific?

[Jennifer D Smith]

I want the ability to get all Teams in our instance.

Without admin controls or pagination in the Teams display we need some way to know how many Teams are out there. Ideally also when they were created and by whom.

[Mick Szucs]

Thanks, April,

I overlooked this because it seems to be somehow separate from the rest of the API documentation?

We've had a number of Teams created in OpsGenie which have now been imported into Jira.

We're looking for a way to programatically enumerate and modify them.

I am surprised that the obviously useful functionality of "get all teams" is absent from this API.

Is this still under development?

[April Chi]

Hi @Mick Szucs ,

I overlooked this because it seems to be somehow separate from the rest of the API documentation?

Thanks for the feedback - acknowledging that it seems separate from the rest of the API documentation. I've passed this feedback onto the relevant team. 

We've had a number of Teams created in OpsGenie which have now been imported into Jira.

We're looking for a way to programatically enumerate and modify them.

I am surprised that the obviously useful functionality of "get all teams" is absent from this API.

Is this still under development?

Does the GraphQL API help? In terms of the REST API, it's not in our immediate roadmap but we have the feature request here you can vote for: https://jira.atlassian.com/browse/CLOUD-11862. Acknowledging it is important but our roadmap is currently full while we build more controls for Teams. 

[Oliver Siebenmarck _Polymetis Apps_]

Hi @Mick Szucs , Hi @Jennifer D Smith ,

As @April Chi pointed out, there is the Teams REST API. Unfortunately, that does not include a way to get a list of teams, which is a bit sad.

However, there's also the GraphQL Teams API, which you can actually use to search for Teams. One simple way to get all the teams in a given organization would be using this:

query allTeams($org: ID!) {
  team {
    teamSearchV2 (organizationId: $org, siteId: "None")
    @optIn(to: "Team-search-v2") {
      edges {
        node {
          team {
            displayName
          }
        }
      }
    }
  }
}

Of course, if you know which site (ie. instance) you want to check out, you can also give it a siteId instead of None.

Hope that helps,
 Oliver

[April Chi]

Hey @Jennifer D Smith ,

I want the ability to get all Teams in our instance.

As @Oliver Siebenmarck says, you can do this via GraphQL. We have some guides for this - do let me know if you need help, the team and are I more than happy to assist. 

This isn't currently available via REST API. We acknowledge that many of you prefer REST API though, so it's on our radar. When we all last spoke, I think building more complete REST APIs was on the roadmap. Unfortunately, this is no longer case as we've prioritised adding more administrative controls to Teams (more on this to come about admin-managed teams, I believe this is where we last left off).

 Ideally also when they were created and by whom.

I don't believe this is in the API response. Keen to hear, what's the use case for this? Is it to run an audit to ensure all the teams are 'valid'?

[Jennifer D Smith]

Replying at this level since I don't seem to be able to thread further

@April Chiyes, we need to know which teams are valid. Both that they exist and that they haven't been casually renamed. All of this is important to us because we're missing features like admin controls, full access to Team in search and dashboards, and the ability to apply contexts to Team.

Team metadata is important to us (this is probably an unusual use case).

• We're associating Teams with different levels of the organization, work in GItHub, and our on-call rotation. This metadata goes into a configuration file, if a "rogue" Team is created it has none of these associations.
• If a Team is renamed it doesn't match the above config file and validation in GitHub fails, populating org info in Jira fails.

Renames are generally problematic (less unusual).

• Because Team display can't be filtered, we maintain a naming convention to make type-ahead search work effectively and help our users understand the "home" project for a team.
• Because Team doesn't show up in most dashboard gadgets and isn't in basic search, we maintain a field called "Team Name" that shadows the Team friendly name (set by a simple automation). If a Team is renamed without the field options being updated this fails.

We have an education effort and a red banner on the site telling people not to create and rename Teams but there are still plenty of people who miss it.

[Steffen Opel _Utoolity_]

While Implement a REST API endpoint to fetch all Teams (CLOUD-11862) is still open, it looks like the GET teams REST API has been made available meanwhile (works for me):

This returns a list of all teams contained under an organization. This may be used as an option to export teams data within your organization.