Conventional HTTP response codes indicate the success or failure of an API request:
- 2xx codes indicate success.
- 3xx codes indicate client must take additional action to complete the request.
- 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.
|303||See Other||The response to the request can be found under another URI using the GET method|
|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|
|410||Gone||The resource requested is no longer available|
|422||Unprocessable Entity||The request was well-formed but the server was unable to process the contained instructions|
|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|
|errors||[object]||A list of errors detailing the resource, field, and error code to aid clients in diagnosing problems|
|errors.code||string||Error code to assist with diagnosing problems|
|errors.field||string||Target field of a specific error|
|errors.resource||string||Target resource of a specific error|
|message||string||Human readable description of the response|
|request_id||string||A unique identifier for the request|
"message": "Invalid request",