Slope uses standard HTTP status codes to denote an error. A 4xx range indicates an error on the client side while a 5xx range error indicates an issue on Slope's end. All errors will be returned in JSON format with these fields:

AttributeValue
statusCodeA HTTP status code
messageA human readable message
errorThe error type

Example error

{
    "statusCode": 404,
    "message": "customer not found",
    "error": "Not Found",
}

Request IDs

You may supply an optional UUID in the HTTP header field X-Request-ID which will be logged and returned back to you for debugging. If none is provided, we will automatically generated a UUID for you. This ID can be used to debug requests when hitting our API.