Skip to main content
Skip table of contents

Excel-like Tables for Jira – Simplified REST API Response and Data Structure

This API returns the full spreadsheet data stored on a Jira issue in a structured JSON format.


Top-Level Structure

CODE
{
  "version": "17.0.4",
  "sheetCount": 1,
  "sheets": { ... }
}
  • sheetCount indicates how many sheets are present

  • sheets contains the spreadsheet data


Accessing Cell Data

CODE
"data": {
  "dataTable": {
    "0": {
      "0": { "value": "ID" },
      "1": { "value": "Task" }
    },
    "1": {
      "0": { "value": 1 },
      "1": { "value": "Review request" }
    }
  }
}

Structure

  • Row and column indexes are 0-based

  • Indexes are returned as strings

  • Only populated cells are included

CODE
dataTable → rowIndex → colIndex → value

Cell Object

CODE
{
  "value": "Review request"
}
  • value contains the resolved cell value (string, number, or empty)


Comments (Optional)

CODE
"comments": [
  {
    "rowIndex": 4,
    "colIndex": 2,
    "text": "read-field Amount"
  }
]

Spreadsheet-style comments attached to specific cells.


Notes for Automation

  • The API always returns the entire table

  • Calculations are already resolved

  • Scripts should safely handle missing rows or columns

  • Most automation only needs sheets → Sheet1 → data → dataTable

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.