Explore the Jira API data model

See how the various Jira endpoints relate to each other, using our handy Entity Relationship Diagram

Try our interactive ERD Or, browse below

Pulling data from the Jira API is only the first part of your reporting. You also need to understand the relationships between different endpoints - something that APIs typically fail to convey.

At SyncHub, we not only sync your Jira API endpoints down into a reportable format, we also describe their relationships (e.g. in terms of foreign keys) so that you can quickly get a grasp of your data and how it fits together. This page is intended as technical documentation of these relationships.

Endpoints

RichText

Documentation: https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/

Column Type Relates to Notes
RemoteID string - -
RichTextRemoteID string RichText → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ParentRemoteID string - -
ParentTypeID int - -
ParentType string - -
SiblingSortOrder int - -
OverallSortOrder string - -
ContentDepth int - -
Type string - -
Text string - -
Version string - -
IsTopLevelNode boolean - -
TopLevelNodeRichTextRemoteID string RichText → RemoteID -

Board

Documentation: https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-rest-agile-1-0-board-get

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Type string - -
ProjectID long Project → ID -
Self string - -

FieldDefinition

Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-get

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID string - -
Name string - -
Description string - -
Key string - -
SearcherKey string - -
StableID string - -
ScreensCount int - -
ContextsCount int - -
Orderable boolean - -
Searchable boolean - -
Custom boolean - -
IsLocked boolean - -
LastUsedType string - -
LastUsedDate datetime - -
SchemaCustom string - -
CustomID long - -
SchemaItems string - -
SchemaSystem string - -
SchemaType string - -

Group

Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-groups/#api-rest-api-3-group-bulk-get

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
GroupID guid - -

Issue

Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-search/#api-rest-api-3-search-get

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Updated datetime - -
Created datetime - -
Duedate datetime - -
Statuscategorychangedate datetime - -
Timespent decimal - -
Aggregatetimespent decimal - -
Aggregatetimeoriginalestimate decimal - -
Timeestimate decimal - -
Timeoriginalestimate decimal - -
Votes int - -
DescriptionRichTextRemoteID string RichText → RemoteID -
Summary string - -
AggregateProgress decimal - -
AggregateProgressTotal decimal - -
ProjectID long Project → ID -
IssueTypeID long IssueType → ID -
StatusID long Status → ID -
AssigneeID string User → AccountID -
CreatorID string User → AccountID -
ReporterID string User → AccountID -
WatchCount long - -
IsWatching boolean - -
Self string - -

IssueType

Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-types/#api-rest-api-3-issuetype-get

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
AvatarID long - -
HierarchyLevel long - -
IconUrl string - -
Subtask boolean - -
Self string - -

Project

Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects/#api-rest-api-3-project-search-get

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
LeadUserID string User → AccountID -
ProjectCategoryID long ProjectCategory → ID -
Simplified boolean - -
IsPrivate boolean - -
Style string - -
Self string - -

ProjectCategory

Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories/#api-rest-api-3-projectcategory-get

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
Self string - -

Status

Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status/#api-rest-api-3-statuses-get

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Description string - -
StatusCategoryName string - -
IconUrl string - -
IsDefault boolean - -
ScopeProjectID long Project → ID -
ScopeType string - -
Self string - -

User

Documentation: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-rest-api-3-users-search-get

Column Type Relates to Notes
RemoteID string - -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
TimeZone string - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Name string - -
AccountID string - -
AccountType string - -
DisplayName string - -
EmailAddress string - -
Key string - -
Self string - -
Active boolean - -

BoardFeature

Documentation: https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-rest-agile-1-0-board-boardid-features-get

Column Type Relates to Notes
RemoteID string - -
BoardRemoteID string Board → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
BoardID long Board → ID -
Feature string - -
State string - -
LocalisedName string - -
LocalisedDescription string - -
LearnMoreLink string - -
ImageUri string - -
FeatureCategory string - -
ToggleLocked boolean - -

Epic

Documentation: https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-rest-agile-1-0-board-boardid-epic-get

Column Type Relates to Notes
RemoteID string - -
BoardRemoteID string Board → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
Summary string - -
Done boolean - -
BoardID long Board → ID -
Self string - -

Sprint

Documentation: https://developer.atlassian.com/cloud/jira/software/rest/api-group-sprint/#api-group-sprint

Column Type Relates to Notes
RemoteID string - -
BoardRemoteID string Board → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
Name string - -
State string - -
Goal string - -
StartDate datetime - -
EndDate datetime - -
CompleteDate datetime - -
BoardID long Board → ID -
Self string - -

IssueSprint

Column Type Relates to Notes
RemoteID string - -
IssueRemoteID string Issue → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
SprintID long Sprint → ID -
IssueID long Issue → ID -

IssueCustomField

Column Type Relates to Notes
RemoteID string - -
IssueRemoteID string Issue → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Iterator long - -
FieldID string FieldDefinition → ID -
DecimalValue decimal - -
StringValue string - -
DateValue datetime - -
IntegerValue long - -
AccountID string User → AccountID -
IssueID long Issue → ID -

IssueLabel

Column Type Relates to Notes
RemoteID string - -
IssueRemoteID string Issue → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
Label string - -
IssueID long Issue → ID -

UserGroup

Column Type Relates to Notes
RemoteID string - -
UserRemoteID string User → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
UserID string User → AccountID -
GroupID guid - -

IssueComment

Column Type Relates to Notes
RemoteID string - -
IssueRemoteID string Issue → RemoteID -
WhenUpsertedIntoDataStore datetime - -
MirrorRemoteID int - -
IsDeleted boolean - -
WhenCreated datetime - -
WhenModified datetime - -
ID long - -
IssueID long Issue → ID -
BodyRichTextRemoteID string RichText → RemoteID -
Created datetime - -
Updated datetime - -
JsdPublic boolean - -
CreatedByUserID string User → AccountID -
UpdatedByUserID string User → AccountID -
Self string - -

Need more?

SyncHub lives and breathes APIs and data. Keep exploring using the links below.

Connect your own Jira data Querying Jira using regular SQL