Legacy Spreadsheets

Use Workiva’s Legacy Spreadsheets endpoints to import, update, and fetch data from Spreadsheets.

A few items differ in terms of errors, and rate limits. See below for details.

Legacy Spreadsheets Errors

Below are details about legacy spreadsheets errors. These details apply to all /spreadsheets/v1 endpoints.

Conventional HTTP response codes indicate the success or failure of an API request:

• 2xx codes indicate success.

• 3xx codes indicate client must take additional action to complete the request.

• 4xx codes indicate a failure due to the information provided, such as an omitted required parameter or incorrect permissions.

• 5xx codes indicate an error with Workiva’s servers.

Code	Meaning	Description
303	See Other	The response to the request can be found under another URI using the GET method
400	Bad Request	The request was unacceptable, often due to missing a required parameter
401	Unauthorized	No valid API token provided
403	Forbidden	The API token doesn’t have permissions to perform the request
404	Not Found	The requested resource doesn’t exist
409	Conflict	The request conflicts with another request
410	Gone	The resource requested is no longer available
422	Unprocessable Entity	The request was well-formed but the server was unable to process the contained instructions
429	Too Many Requests	Too many requests too quickly, recommend backoff
500	Internal Server Error	Something went wrong on Workiva’s end
503	Service Unavailable	The server can’t handle the request due to a temporary overload or scheduled maintenance

Error Object

Name	Type	Required	Description
errors	[object]		A list of errors detailing the resource, field, and error code to aid clients in diagnosing problems
errors.code	string		Error code to assist with diagnosing problems
errors.field	string		Target field of a specific error
errors.resource	string		Target resource of a specific error
message	string		Human readable description of the response
request_id	string		A unique identifier for the request

Error Example

{
  "errors": [
    {
      "code": "already_exists",
      "field": "name",
      "resource": "spreadsheet"
    }
  ],
  "message": "Invalid request",
  "request_id": "d6a6ce3f-f120-4104-9587-a5a2dc45626c"
}

Legacy Spreadsheets Limits

To ensure a positive experience for all, the Workiva Legacy Spreadsheets endpoints enforce a number of constraints.

Rate Limits

The Workiva Legacy Spreadsheets endpoints may rate limit clients based on the current system load or an excessive request frequency. In these cases, you will receive an error response with status code 429 Too Many Requests. To help mitigate this, we recommend respecting any Retry-After response headers when provided.

Payload Size

The Workiva Spreadsheets API currently limits the size of any request payloads to a maximum of 10485760 bytes (10MB).

Timeouts

The Workiva Spreadsheets API currently limits the length of any request to 29 seconds.

Feature Limits

FEATURE	LIMIT
Sheets per Spreadsheet	1,000
Cells per Spreadsheet	2,000,000
Rows per Sheet	1,048,576
Columns per Sheet	16,384
Sheet name length	100
Characters per cell	32,767