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
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
504Gateway TimeoutThe request did not complete within a timely manner

Error Object

codestringtrueA server-defined error code
details[object]false[Additional details of the error]
details.codestringtrueError code of specific error
details.messagestringtrueMessage of specific error
details.targetstringfalseTarget of specific error
messagestringtrueA human-readable representation of the error
targetstringfalseThe target of the error

Error Example

  "code": "BadArgument",
  "message": "Multiple errors in ContactInfo data",
  "target": "ContactInfo",
  "details": [{
    "code": "NullValue",
    "target": "PhoneNumber",
    "message": "Phone number must not be null"
  }, {
    "code": "NullValue",
    "target": "LastName",
    "message": "Last name must not be null"
  }, {
    "code": "MalformedValue",
    "target": "Address",
    "message": "Address is not valid"