API Reference

📘

All calls to the Workiva Spreadsheets API may return a message and request_id as part of the JSON response. If present, message contains a human readable descriptions of the response condition. request_id is a unique identifier for the request.

Spreadsheet

Properties

NameTypeDescriptionRestrictions
createdstring(date-time)Date-time (UTC) corresponding to the creation of the spreadsheet
idstringUnique identifier for the spreadsheet
last_modifiedstring(date-time)Date-time (UTC) corresponding to the last modification of the spreadsheet
namestringDisplay name for the spreadsheet

Example

{
  "created": "2020-04-30T13:59:49.294Z",
  "id": "567nd179ed984eb5a52aaaba5f83a230",
  "last_modified": "2020-04-30T13:59:52.003Z",
  "name": "Test Spreadsheet"
}

Sheet

Properties

NameTypeDescriptionRestrictions
child_ids[string]Array of unique identifiers for the child sheets of the sheet. This will be empty if the sheet has no children in the spreadsheet outline.
idstringUnique identifier for the sheet
indexintegerZero-based index specifying the position of this sheet in relation to sibling sheets
namestringDisplay name for the sheet
parent_idstringUnique identifier for the parent sheet of the sheet. This will be empty if the sheet is at the top level of the spreadsheet outline.

Example

{
  "child_ids": [
    "h65a604b74564afa86b5ba96755845652"
  ],
  "id": "k78a604b74564afa76b5ba96755123456",
  "index": 0,
  "name": "Data Sheet",
  "parent_id": "d10a604b74564afa86b5ba96755845652"
}