Teams queries and mutations are available under the team namespace in the Atlassian platform
GraphQL API.
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.
The API authenticates users making requests to fetch a team and associated data. Only users with permission can view and access teams.
You can use OAuth 2.0 to request data on behalf of a user. The required scopes are specified in the queries.
Read more about authentication in the GraphQL API reference.
The Atlassian GraphQL Gateway applies cost-based, per-user rate limits. A rate-limited request
returns HTTP 429 Too Many Requests for the entire request and includes a Retry-After header.
Wait until the time in that header before retrying.
For the current policy, see Rate limiting and query retries.
Some Teams queries and mutations are Experimental. Check the field description in the GraphQL API reference before using one. For information about accessing fields marked as beta, see Beta fields.
The teamSearchV2 query allows you to search for teams within an organization. You can filter by
text query, membership, and team types.
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 2filter: { 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.
For more information, including details of the Team entity, check out the GraphQL API section in our Reference Documentation.
Rate this page: