Using Team Queries

Team Queries allow you to fetch the data of a team for a given ID.

Team ID

The team's ID must be in the form of an Atlassian Resource Identifier. For example, the ID should be prefixed with ari:cloud:identity::team/ and may look like ari:cloud:identity::team/xxx-xxx-xxxx

Authentication

The API authenticates users making requests to fetch a team and associated data. Only users with permission can view and access teams.

It is possible to use OAuth to request data on behalf of a user. The required scoped are specified in the queries.

Read more about authentication from the GraphQL reference documentation.

Rate limits

Rate limits are applied per user when they:

• Request a team 40 times per minute
• Request the members of a team 20 times per minute

These rate limits may be increased or decreased in the future.

Beta state

The Team entity is in Beta state which allows us to monitor and ensure it operates as expected. The Team Query requires additional request headers to access fields in beta:

1
2
{
    "X-ExperimentalApi": ["teams-beta", "team-members-beta"]
}

The teams-beta header is required to query a team.

The additional team-members-beta header is required to query the members of a team.

Team Search

The teamSearchV2 query allows you to search for teams within an organization. You can filter by text query, membership, and team types.

Membership Filter

When filtering teams by membership using the membership filter with memberIds, only 1 member ID is accepted. If multiple member IDs are provided in the array, only the first one will be used for filtering.

Example filter usage:

1
2
filter: {
  membership: {
    memberIds: ["single-account-id"]  # Only 1 ID is supported
  }
}

This behavior is consistent with the REST API, which explicitly restricts the membership filter to a single member ID.

Further information

For more information, including details of the Team entity, check out the GraphQL API section in our Reference Documentation.