API Reference

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.
CodeMeaningDescription
303See OtherThe response to the request can be found under another URI using the GET method
400Bad RequestThe request was unacceptable, often due to missing a required parameter
401UnauthorizedNo valid API token provided
403ForbiddenThe API token doesn't have permissions to perform the request
404Not FoundThe requested resource doesn't exist
409ConflictThe request conflicts with another request
410GoneThe resource requested is no longer available
422Unprocessable EntityThe request was well-formed but the server was unable to process the contained instructions
429Too Many RequestsToo many requests too quickly, recommend backoff
500Internal Server ErrorSomething went wrong on Workiva's end
503Service UnavailableThe server can't handle the request due to a temporary overload or scheduled maintenance

Error Object

NameTypeRequiredDescription
errors[object]A list of errors detailing the resource, field, and error code to aid clients in diagnosing problems
errors.codestringError code to assist with diagnosing problems
errors.fieldstringTarget field of a specific error
errors.resourcestringTarget resource of a specific error
messagestringHuman readable description of the response
request_idstringA 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"
}