Skip to main content

Jira

Prerequisites

  • API Token
  • Domain
  • Email

Setting up the Jira connector

NoItemRequiredExampleNotes
1API TokenYesJira API Token. See the docs for more information on how to generate this key.
2DomainYesdomainname.atlassian.netThe Domain for your Jira account, e.g. zipstackio.atlassian.net
3EmailYesThe user email for your Jira account.
4ProjectsNoPROJ1
PROJ2
List of Jira project keys to replicate data for.
5Start DateNo2021-03-01T00:00:00ZThe date from which you want to replicate data from Jira, use the format YYYY-MM-DDT00:00:00Z. Note that this field only applies to certain streams, and only data generated on or after the start date will be replicated. For more information, refer to the documentation.
6Expand Issue ChangelogNoExpand the changelog when replicating issues.
7Render Issue FieldsNoRender issue fields in HTML format in addition to Jira JSON-like format.
8Enable Experimental StreamsNoAllow the use of experimental streams which rely on undocumented Jira API endpoints. See https://docs.zipstack.com/integrations/sources/jira#experimental-tables for more info.

Tables in the Jira connector

NoTable NameColumnsPrimary KeysRead ModeInc. Sync KeysAPI Info
1projects33idFull RefreshAPI Reference
2jql3
3issue_link_types5idFull Refresh
4issue_comments11idFull Refresh, Incrementalupdated
5dashboards10idFull RefreshAPI Reference
6issues19idFull Refresh, IncrementalupdatedAPI Reference
7pull_requests6
8project_components14idFull Refresh
9issue_notification_schemes7idFull Refresh
10permissions4keyFull RefreshAPI Reference
11sprints9idFull RefreshAPI Reference
12workflow_status_categories5idFull Refresh
13avatars7idFull RefreshAPI Reference
14screen_tabs2idFull Refresh
15jira_settings9idFull Refresh
16board_issues8idFull Refresh, Incrementalupdated
17issue_resolutions4idFull Refresh
18users14accountIdFull RefreshAPI Reference
19labels1labelFull RefreshAPI Reference
20issue_type_schemes5idFull Refresh
21issue_custom_field_contexts5idFull Refresh
22workflow_statuses6idFull Refresh
23project_email2projectIdFull Refresh
24issue_comment_properties2
25filter_sharing5idFull Refresh
26issue_field_configurations4idFull Refresh
27audit_records11
28issue_security_schemes6idFull Refresh
29workflow_scheme_drafts13
30issue_worklogs13idFull Refresh, Incrementalupdated
31screen_schemes5idFull Refresh
32workflow_transition_rules4
33permission_schemes7idFull Refresh
34issue_priorities6idFull Refresh
35issue_type_screen_schemes3idFull Refresh
36boards6idFull RefreshAPI Reference
37workflows4idFull RefreshAPI Reference
38project_types5Full Refresh
39issue_remote_links6idFull Refresh
40project_versions17idFull Refresh
41dynamic_modules1
42issue_type_properties2
43screens4idFull RefreshAPI Reference
44issue_navigator_settings2Full Refresh
45workflow_schemes13idFull Refresh
46application_roles13keyFull Refresh
47time_tracking3keyFull Refresh
48sprint_issues9idFull Refresh, Incrementalupdated
49issue_watchers4Full Refresh
50issue_custom_field_options_apps4
51project_categories4idFull Refresh
52project_permission_schemes4idFull Refresh
53screen_tab_fields2idFull Refresh
54groups2groupIdFull RefreshAPI Reference
55filters14idFull RefreshAPI Reference
56issue_types10
57project_avatars7idFull Refresh
58server_info10
59issue_custom_field_options4
60workflow_scheme_project_associations2
61issue_properties2keyFull Refresh
62issue_votes4Full Refresh
63webhooks4
64workflow_transition_properties3
65issue_fields10idFull Refresh
66users_groups_detailed14accountIdFull Refresh

Table: projects

NoColumn NameTypeNotes
1componentsVARCHAR
2rolesVARCHAR
3descriptionVARCHAR
4isPrivateBOOLEAN
5uuidVARCHAR
6deletedByVARCHAR
7issueTypesVARCHAR
8archivedBOOLEAN
9projectCategoryVARCHAR
10permissionsVARCHAR
11idVARCHARPrimary Key
12assigneeTypeVARCHAR
13projectTypeKeyVARCHAR
14archivedByVARCHAR
15keyVARCHAR
16emailVARCHAR
17archivedDateVARCHAR
18retentionTillDateVARCHAR
19avatarUrlsVARCHAR
20favouriteBOOLEAN
21leadVARCHAR
22urlVARCHAR
23insightVARCHAR
24expandVARCHAR
25deletedBOOLEAN
26simplifiedBOOLEAN
27versionsVARCHAR
28deletedDateVARCHAR
29issueTypeHierarchyVARCHAR
30nameVARCHAR
31selfVARCHAR
32styleVARCHAR
33propertiesVARCHAR

Table: jql

NoColumn NameTypeNotes
1visibleFieldNamesVARCHAR
2visibleFunctionNamesVARCHAR
3jqlReservedWordsVARCHAR
NoColumn NameTypeNotes
1inwardVARCHAR
2nameVARCHAR
3selfVARCHAR
4idVARCHARPrimary Key
5outwardVARCHAR

Table: issue_comments

NoColumn NameTypeNotes
1renderedBodyVARCHAR
2visibilityVARCHAR
3authorVARCHAR
4createdVARCHAR
5updateAuthorVARCHAR
6selfVARCHAR
7jsdPublicBOOLEAN
8idVARCHARPrimary Key
9bodyVARCHAR
10updatedVARCHARIncremental sync key
11propertiesVARCHAR

Table: dashboards

NoColumn NameTypeNotes
1ownerVARCHAR
2viewVARCHAR
3popularityINTEGER
4nameVARCHAR
5descriptionVARCHAR
6rankINTEGER
7selfVARCHAR
8idVARCHARPrimary Key
9sharePermissionsVARCHAR
10isFavouriteBOOLEAN

Table: issues

NoColumn NameTypeNotes
1schemaVARCHAR
2createdVARCHAR
3editmetaVARCHAR
4fieldsToIncludeVARCHAR
5changelogVARCHAR
6transitionsVARCHAR
7renderedFieldsVARCHAR
8expandVARCHAR
9projectKeyVARCHAR
10namesVARCHAR
11operationsVARCHAR
12versionedRepresentationsVARCHAR
13selfVARCHAR
14idVARCHARPrimary Key
15fieldsVARCHAR
16projectIdVARCHAR
17updatedVARCHARIncremental sync key
18keyVARCHAR
19propertiesVARCHAR

Table: pull_requests

NoColumn NameTypeNotes
1repositoriesVARCHAR
2idVARCHAR
3pullRequestsVARCHAR
4branchesVARCHAR
5updatedVARCHAR
6_instanceVARCHAR

Table: project_components

NoColumn NameTypeNotes
1leadUserNameVARCHAR
2descriptionVARCHAR
3projectVARCHAR
4leadAccountIdVARCHAR
5leadVARCHAR
6isAssigneeTypeValidBOOLEAN
7realAssigneeTypeVARCHAR
8nameVARCHAR
9selfVARCHAR
10realAssigneeVARCHAR
11idVARCHARPrimary Key
12assigneeTypeVARCHAR
13assigneeVARCHAR
14projectIdINTEGER

Table: issue_notification_schemes

NoColumn NameTypeNotes
1expandVARCHAR
2scopeVARCHAR
3nameVARCHAR
4selfVARCHAR
5descriptionVARCHAR
6idINTEGERPrimary Key
7notificationSchemeEventsVARCHAR

Table: permissions

NoColumn NameTypeNotes
1nameVARCHAR
2descriptionVARCHAR
3typeVARCHAR
4keyVARCHARPrimary Key

Table: sprints

NoColumn NameTypeNotes
1originBoardIdINTEGER
2goalVARCHAR
3endDateVARCHAR
4nameVARCHAR
5selfVARCHAR
6idINTEGERPrimary Key
7stateVARCHAR
8startDateVARCHAR
9completeDateVARCHAR

Table: workflow_status_categories

NoColumn NameTypeNotes
1colorNameVARCHAR
2nameVARCHAR
3selfVARCHAR
4idINTEGERPrimary Key
5keyVARCHAR

Table: avatars

NoColumn NameTypeNotes
1ownerVARCHAR
2isDeletableBOOLEAN
3fileNameVARCHAR
4urlsVARCHAR
5isSystemAvatarBOOLEAN
6isSelectedBOOLEAN
7idVARCHARPrimary Key

Table: screen_tabs

NoColumn NameTypeNotes
1nameVARCHAR
2idINTEGERPrimary Key

Table: jira_settings

NoColumn NameTypeNotes
1allowedValuesVARCHAR
2defaultValueVARCHAR
3nameVARCHAR
4idVARCHARPrimary Key
5typeVARCHAR
6valueVARCHAR
7keyVARCHAR
8descVARCHAR
9exampleVARCHAR

Table: board_issues

NoColumn NameTypeNotes
1expandVARCHAR
2createdVARCHAR
3selfVARCHAR
4boardIdINTEGER
5idVARCHARPrimary Key
6fieldsVARCHAR
7updatedVARCHARIncremental sync key
8keyVARCHAR

Table: issue_resolutions

NoColumn NameTypeNotes
1nameVARCHAR
2selfVARCHAR
3descriptionVARCHAR
4idVARCHARPrimary Key

Table: users

NoColumn NameTypeNotes
1avatarUrlsVARCHAR
2displayNameVARCHAR
3accountTypeVARCHAR
4activeBOOLEAN
5timeZoneVARCHAR
6groupsVARCHAR
7localeVARCHAR
8accountIdVARCHARPrimary Key
9emailAddressVARCHAR
10expandVARCHAR
11nameVARCHAR
12selfVARCHAR
13keyVARCHAR
14applicationRolesVARCHAR

Table: labels

NoColumn NameTypeNotes
1labelVARCHARPrimary Key

Table: issue_type_schemes

NoColumn NameTypeNotes
1isDefaultBOOLEAN
2defaultIssueTypeIdVARCHAR
3nameVARCHAR
4descriptionVARCHAR
5idVARCHARPrimary Key

Table: issue_custom_field_contexts

NoColumn NameTypeNotes
1nameVARCHAR
2descriptionVARCHAR
3idVARCHARPrimary Key
4isGlobalContextBOOLEAN
5isAnyIssueTypeBOOLEAN

Table: workflow_statuses

NoColumn NameTypeNotes
1nameVARCHAR
2selfVARCHAR
3descriptionVARCHAR
4iconUrlVARCHAR
5idVARCHARPrimary Key
6statusCategoryVARCHAR

Table: project_email

NoColumn NameTypeNotes
1emailAddressVARCHAR
2projectIdVARCHARPrimary Key

Table: issue_comment_properties

NoColumn NameTypeNotes
1valueVARCHAR
2keyVARCHAR

Table: filter_sharing

NoColumn NameTypeNotes
1roleVARCHAR
2projectVARCHAR
3idINTEGERPrimary Key
4typeVARCHAR
5groupVARCHAR

Table: issue_field_configurations

NoColumn NameTypeNotes
1isDefaultBOOLEAN
2nameVARCHAR
3descriptionVARCHAR
4idINTEGERPrimary Key

Table: audit_records

NoColumn NameTypeNotes
1summaryVARCHAR
2changedValuesVARCHAR
3objectItemVARCHAR
4createdVARCHAR
5authorKeyVARCHAR
6eventSourceVARCHAR
7descriptionVARCHAR
8associatedItemsVARCHAR
9idINTEGER
10categoryVARCHAR
11remoteAddressVARCHAR

Table: issue_security_schemes

NoColumn NameTypeNotes
1nameVARCHAR
2selfVARCHAR
3descriptionVARCHAR
4defaultSecurityLevelIdINTEGER
5idINTEGERPrimary Key
6levelsVARCHAR

Table: workflow_scheme_drafts

NoColumn NameTypeNotes
1originalDefaultWorkflowVARCHAR
2descriptionVARCHAR
3issueTypesVARCHAR
4originalIssueTypeMappingsVARCHAR
5defaultWorkflowVARCHAR
6updateDraftIfNeededBOOLEAN
7draftBOOLEAN
8nameVARCHAR
9selfVARCHAR
10lastModifiedUserVARCHAR
11idINTEGER
12lastModifiedVARCHAR
13issueTypeMappingsVARCHAR

Table: issue_worklogs

NoColumn NameTypeNotes
1issueIdVARCHAR
2visibilityVARCHAR
3timeSpentVARCHAR
4authorVARCHAR
5createdVARCHAR
6startedVARCHAR
7timeSpentSecondsINTEGER
8updateAuthorVARCHAR
9selfVARCHAR
10commentVARCHAR
11idVARCHARPrimary Key
12updatedVARCHARIncremental sync key
13propertiesVARCHAR

Table: screen_schemes

NoColumn NameTypeNotes
1issueTypeScreenSchemesVARCHAR
2screensVARCHAR
3nameVARCHAR
4descriptionVARCHAR
5idINTEGERPrimary Key

Table: workflow_transition_rules

NoColumn NameTypeNotes
1postFunctionsVARCHAR
2validatorsVARCHAR
3conditionsVARCHAR
4workflowIdVARCHAR

Table: permission_schemes

NoColumn NameTypeNotes
1expandVARCHAR
2permissionsVARCHAR
3scopeVARCHAR
4nameVARCHAR
5selfVARCHAR
6descriptionVARCHAR
7idINTEGERPrimary Key

Table: issue_priorities

NoColumn NameTypeNotes
1statusColorVARCHAR
2nameVARCHAR
3selfVARCHAR
4descriptionVARCHAR
5iconUrlVARCHAR
6idVARCHARPrimary Key

Table: issue_type_screen_schemes

NoColumn NameTypeNotes
1nameVARCHAR
2descriptionVARCHAR
3idVARCHARPrimary Key

Table: boards

NoColumn NameTypeNotes
1projectKeyVARCHAR
2nameVARCHAR
3selfVARCHAR
4idINTEGERPrimary Key
5typeVARCHAR
6projectIdVARCHAR

Table: workflows

NoColumn NameTypeNotes
1descriptionVARCHAR
2statusesVARCHAR
3idVARCHARPrimary Key
4transitionsVARCHAR

Table: project_types

NoColumn NameTypeNotes
1descriptionI18nKeyVARCHAR
2colorVARCHAR
3iconVARCHAR
4keyVARCHAR
5formattedKeyVARCHAR
NoColumn NameTypeNotes
1applicationVARCHAR
2globalIdVARCHAR
3selfVARCHAR
4idINTEGERPrimary Key
5relationshipVARCHAR
6objectVARCHAR

Table: project_versions

NoColumn NameTypeNotes
1releaseDateVARCHAR
2descriptionVARCHAR
3projectVARCHAR
4archivedBOOLEAN
5expandVARCHAR
6operationsVARCHAR
7overdueBOOLEAN
8nameVARCHAR
9selfVARCHAR
10moveUnfixedIssuesToVARCHAR
11userReleaseDateVARCHAR
12idVARCHARPrimary Key
13userStartDateVARCHAR
14projectIdINTEGER
15releasedBOOLEAN
16startDateVARCHAR
17issuesStatusForFixVersionVARCHAR

Table: dynamic_modules

NoColumn NameTypeNotes
1modulesVARCHAR

Table: issue_type_properties

NoColumn NameTypeNotes
1valueVARCHAR
2keyVARCHAR

Table: screens

NoColumn NameTypeNotes
1scopeVARCHAR
2nameVARCHAR
3descriptionVARCHAR
4idINTEGERPrimary Key

Table: issue_navigator_settings

NoColumn NameTypeNotes
1labelVARCHAR
2valueVARCHAR

Table: workflow_schemes

NoColumn NameTypeNotes
1originalDefaultWorkflowVARCHAR
2descriptionVARCHAR
3issueTypesVARCHAR
4originalIssueTypeMappingsVARCHAR
5defaultWorkflowVARCHAR
6updateDraftIfNeededBOOLEAN
7draftBOOLEAN
8nameVARCHAR
9selfVARCHAR
10lastModifiedUserVARCHAR
11idINTEGERPrimary Key
12lastModifiedVARCHAR
13issueTypeMappingsVARCHAR

Table: application_roles

NoColumn NameTypeNotes
1defaultGroupsVARCHAR
2hasUnlimitedSeatsBOOLEAN
3groupDetailsVARCHAR
4groupsVARCHAR
5remainingSeatsINTEGER
6selectedByDefaultBOOLEAN
7platformBOOLEAN
8numberOfSeatsINTEGER
9userCountINTEGER
10userCountDescriptionVARCHAR
11nameVARCHAR
12keyVARCHARPrimary Key
13definedBOOLEAN

Table: time_tracking

NoColumn NameTypeNotes
1nameVARCHAR
2keyVARCHARPrimary Key
3urlVARCHAR

Table: sprint_issues

NoColumn NameTypeNotes
1sprintIdINTEGER
2expandVARCHAR
3issueIdVARCHAR
4createdVARCHAR
5selfVARCHAR
6idVARCHARPrimary Key
7fieldsVARCHAR
8updatedVARCHARIncremental sync key
9keyVARCHAR

Table: issue_watchers

NoColumn NameTypeNotes
1selfVARCHAR
2watchersVARCHAR
3isWatchingBOOLEAN
4watchCountINTEGER

Table: issue_custom_field_options_apps

NoColumn NameTypeNotes
1idINTEGER
2valueVARCHAR
3configVARCHAR
4propertiesVARCHAR

Table: project_categories

NoColumn NameTypeNotes
1nameVARCHAR
2selfVARCHAR
3descriptionVARCHAR
4idVARCHARPrimary Key

Table: project_permission_schemes

NoColumn NameTypeNotes
1nameVARCHAR
2selfVARCHAR
3descriptionVARCHAR
4idVARCHARPrimary Key

Table: screen_tab_fields

NoColumn NameTypeNotes
1nameVARCHAR
2idVARCHARPrimary Key

Table: groups

NoColumn NameTypeNotes
1groupIdVARCHARPrimary Key
2nameVARCHAR

Table: filters

NoColumn NameTypeNotes
1ownerVARCHAR
2subscriptionsVARCHAR
3jqlVARCHAR
4favouritedCountINTEGER
5descriptionVARCHAR
6favouriteBOOLEAN
7isWritableBOOLEAN
8expandVARCHAR
9nameVARCHAR
10viewUrlVARCHAR
11selfVARCHAR
12searchUrlVARCHAR
13idVARCHARPrimary Key
14sharePermissionsVARCHAR

Table: issue_types

NoColumn NameTypeNotes
1avatarIdINTEGER
2hierarchyLevelINTEGER
3scopeVARCHAR
4nameVARCHAR
5selfVARCHAR
6descriptionVARCHAR
7entityIdVARCHAR
8idVARCHAR
9iconUrlVARCHAR
10subtaskBOOLEAN

Table: project_avatars

NoColumn NameTypeNotes
1ownerVARCHAR
2isDeletableBOOLEAN
3fileNameVARCHAR
4urlsVARCHAR
5isSystemAvatarBOOLEAN
6isSelectedBOOLEAN
7idVARCHARPrimary Key

Table: server_info

NoColumn NameTypeNotes
1healthChecksVARCHAR
2baseUrlVARCHAR
3deploymentTypeVARCHAR
4scmInfoVARCHAR
5serverTimeVARCHAR
6buildDateVARCHAR
7serverTitleVARCHAR
8versionVARCHAR
9buildNumberINTEGER
10versionNumbersVARCHAR

Table: issue_custom_field_options

NoColumn NameTypeNotes
1optionIdVARCHAR
2disabledBOOLEAN
3idVARCHAR
4valueVARCHAR

Table: workflow_scheme_project_associations

NoColumn NameTypeNotes
1projectIdsVARCHAR
2workflowSchemeVARCHAR

Table: issue_properties

NoColumn NameTypeNotes
1valueVARCHAR
2keyVARCHARPrimary Key

Table: issue_votes

NoColumn NameTypeNotes
1hasVotedBOOLEAN
2votersVARCHAR
3selfVARCHAR
4votesINTEGER

Table: webhooks

NoColumn NameTypeNotes
1jqlFilterVARCHAR
2idINTEGER
3eventsVARCHAR
4expirationDateINTEGER

Table: workflow_transition_properties

NoColumn NameTypeNotes
1idVARCHAR
2valueVARCHAR
3keyVARCHAR

Table: issue_fields

NoColumn NameTypeNotes
1schemaVARCHAR
2navigableBOOLEAN
3orderableBOOLEAN
4customBOOLEAN
5scopeVARCHAR
6nameVARCHAR
7clauseNamesVARCHAR
8idVARCHARPrimary Key
9keyVARCHAR
10searchableBOOLEAN

Table: users_groups_detailed

NoColumn NameTypeNotes
1avatarUrlsVARCHAR
2displayNameVARCHAR
3accountTypeVARCHAR
4activeBOOLEAN
5timeZoneVARCHAR
6groupsVARCHAR
7localeVARCHAR
8accountIdVARCHARPrimary Key
9emailAddressVARCHAR
10expandVARCHAR
11nameVARCHAR
12selfVARCHAR
13keyVARCHAR
14applicationRolesVARCHAR

External Resources

Zipstack Cloud features a powerful SQL querying engine on top of many types of connectors, including those from Trino, some custom connectors and connectors from the open source Airbyte project. Some Zipstack cloud connectors are designed to utilize and expand upon Airbyte's connector protocol, but they do not use Airbyte's EL core. Additionally, some parts of the documentation for these connectors have been adapted from the connector documentation found in Airbyte's open source project.