The following response codes can be returned by the API:
Status Code | Reason phrase | Description |
---|---|---|
200 | Success | Request processed successfully. |
400 | Bad Request | Request failed due to malformed syntax. |
408 | Request timeout | Response was not returned within the timeout allowance. |
500 | Internal Server Error | The server has encountered an error. |
Successful API request returns the response within a result
object. However, should an error occur, an error
object is returned instead with the below fields.
Name | Type | Description |
---|---|---|
type | string | A link to documentation that provides more details about the error you've encountered. |
title | string | The title of the error. |
detail | string | A description of the error. |