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 |
The API token is invalid, expired, or does not have permissions to perform the request |
404 |
Not Found |
The requested resource doesn’t exist |
409 |
Conflict |
The request conflicts with another request |
422 |
Unprocessable Entity |
The request is well formed, but the server was unable to process the request |
429 |
Too Many Requests |
Too many requests too quickly, recommend backoff |
500 |
Internal Server Error |
Something went wrong on Workiva’s end |
Error Object#
Name |
Type |
Required |
Description |
|---|---|---|---|
error |
string |
false |
A server-defined error |
error_description |
string |
false |
Additional details of the error |
Example Error#
{
"error": "string",
"error_description": "string"
}