Developer
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Object types
Relationship types
Last updated Jan 8, 2026

Compass component

The Teamwork Graph API is available through Forge's Early Access Program (EAP).

EAPs are offered to selected users for testing and feedback purposes. These features are unsupported and are subject to change without notice.

You must only install apps that call the Teamwork Graph API in test organizations. Apps calling the Teamwork Graph API require the read:graph:jiraor read:graph:confluence scope, which provides access to Teamwork Graph data across your entire organization. While apps still respect end-user permissions, this scope may grant access to sensitive information. For safety, only install these apps in organizations with test data. Do not install apps using this API in organizations with production data while this feature is in EAP.

Additionally, this EAP has significant limitations. To review the full list of limitations, see Limitations and considerations.

You must be part of this EAP in order to use the Teamwork Graph API. Express interest in joining through this form.

Represents a software component tracked in Compass, Atlassian's developer experience platform. Components define microservices, libraries, or other software artifacts with associated metadata, ownership, and health metrics.

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 Compass component.

FieldTypeDescription
descriptionStringThe description of the component.
idID!The unique identifier (ID) of the component.
nameString!The name of the component.
ownerIdIDThe unique identifier (ID) of the team that owns the component.
stateStringThe state of the component.
typeIdID!The type of component.
urlURLThe URL to the component in Compass.

Available relationships

The following relationships are currently supported for Compass component:

Relationships where Compass component is the source object.

Relationship nameFrom object typeTo object type
JSM incident impacts Compass componentCompass componentJira work item
Compass component has Compass component linkCompass componentCompass component link

Rate this page: