Preview features are available to all users and receive the same level of support as generally available features. Schemas, fields, and behavior may still change before general availability (GA), and breaking changes are subject to a minimum 1-month deprecation notice, announced in the Teamwork Graph changelog.

To review the current limitations, see Limitations and considerations.

To share feedback or report an issue, visit the Atlassian developer community.

Represents a group in the Atlassian Identity system. Groups are collections of users that can be used for permissions, access control, and organizational structure.

Available fields and properties

The Teamwork Graph API has the following fields and properties that you can use in your queries:

Object type fields are the core data fields of the object. Use these when you want to retrieve specific information about the object in your queries.
Cypher query properties are metadata properties used for filtering and traversing relationships between different object types in Teamwork Graph. Use Cypher query properties when you need to filter or navigate relationships between this object and other objects in your queries.

Object type fields

You can access these fields in the GraphiQL playground using the book icon in the top left, and then searching for Atlassian Group.

Field	Type	Description
`description`	`String`	Description of the group's purpose or membership criteria.
`id`	`ID!`	Unique identifier for the identity group. This ID is globally unique across the entire Teamwork Graph.
`name`	`String`	Name of the group.

Available relationships

The following relationships are currently supported for Atlassian Group:

To relationships

Relationships where Atlassian Group is the target object.

Relationship name	From object type	To object type
Content entity links entity	Confluence blog post Confluence comment Confluence page Jira work item Jira work item comment External branch External build External calendar event External comment External commit External conversation External data table External deployment External design External document External messages External project External pull request External repository External video External vulnerability External work item	Atlassian Group