Use the Teams GraphQL API to read, search, and manage Atlassian teams through the Atlassian GraphQL Gateway. GraphQL is the recommended API for new Teams integrations.

Available capabilities

The API provides queries that let you:

retrieve one or more teams
retrieve team details and members
search for teams within an organization or scope
filter team search results by text, membership, or team type

The API also provides mutations that let you:

create, update, and delete teams
add and remove team members

The public team and membership mutations are Experimental. Experimental operations can change without notice. Check the lifecycle information for each field before using it in a production integration.

Authentication and authorization

The authentication method depends on your client:

OAuth clients use https://api.atlassian.com/graphql.
Browser sessions and API tokens use https://{your-site}.atlassian.net/gateway/api/graphql.

The API authorizes access at the field level. The required OAuth scopes and lifecycle status are shown in each field's description in the GraphQL explorer.

Reference

Use the Teams GraphQL API reference to explore the schema, inspect required scopes, and check lifecycle information. See Use the Teams GraphQL API for request examples.