Errors

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

Two error responses may be returned.

• An error code of 400 returns a multi-error response.

• Any other error code returns a single error response.

Single Error Object

Name	Type	Required	Description
body	string	false	Additional details of the error
code	integer(int32)	false	A server-defined error code

Example Single Error

{
  "code": "404",
  "body": "Not found"
}

Multi Error Object

Name	Type	Required	Description
body	[string]	false	List containing additional details of the error
code	integer(int32)	false	A server-defined error code

Example Multi Error Response

{
  "code": "400",
  "body": ["Invalid request"]
}