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 sprint in Jira - a fixed time period during which specific work is completed.

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 Jira sprint.

Field	Type	Description
`boardId`	`Long`	The ID of the board that the sprint belongs to.
`boardName`	`String`	The board name that the sprint belongs to.
`completedAt`	`DateTime`	Completion date of the sprint.
`endedAt`	`DateTime`	End date of the sprint.
`goal`	`String`	The goal of the sprint.
`id`	`ID!`	Unique identifier for the sprint. This ID is globally unique across the entire Teamwork Graph.
`name`	`String`	Sprint name.
`sprintProgress`	`JiraSprintProgress`	The progress of the sprint.
`startedAt`	`DateTime`	Start date of the sprint.
`state`	`JiraSprintState`	Current state of the sprint.

Fields for JiraSprintProgress

Field	Type	Description
`estimationType`	`String`	Estimation unit of the sprint.

Values for JiraSprintState

Value	Description
`ACTIVE`	The sprint is in progress.
`CLOSED`	The sprint has been completed.
`FUTURE`	The sprint hasn't been started yet.

Available relationships

The following relationships are currently supported for Jira sprint:

From relationships

To relationships

Relationships where Jira sprint is the source object.

Relationship name	From object type	To object type
Jira sprint has retro Confluence page	Jira sprint	Confluence page
Jira sprint has retro Confluence whiteboard	Jira sprint	Confluence whiteboard
Sprint has retro documents	Jira sprint	Confluence page Confluence whiteboard