Errors

Attention

Legacy spreadsheets endpoints use slightly different errors than other endpoints in this API. Here are the details.

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.

Code	Meaning	Description
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
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
504	Gateway Timeout	The request did not complete within a timely manner

Error Object

Name	Type	Required	Description
code	string	true	A server-defined error code
details	[object]	false	[Additional details of the error]
details.code	string	true	Error code of specific error
details.message	string	true	Message of specific error
details.target	string	false	Target of specific error
message	string	true	A human-readable representation of the error
target	string	false	The 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"
  }]
}