API Reference

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

  • 2xx codes indicate success.
  • 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.
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
422Unprocessable EntityThe request is well formed, but the server was unable to process the request
429Too Many RequestsToo many requests too quickly, recommend backoff
500Internal Server ErrorSomething went wrong on Workiva's end

Error Object

errorstringfalseA server-defined error
error_descriptionstringfalseAdditional details of the error

Example Error

  "error": "string",
  "error_description": "string"