Rate limiting and error codes

Rate limiting

Each endpoint in the developer APIs is subject to a rate limiting constraint of 20 requests per second. This is in place to ensure fair usage of our APIs as well as to prevent our servers from being overhwelmed by requests. Issuing too many requests per second will result in requests being rejected with a 429 error code.

Error codes

When a request does not succeed, an error response will be returned. The error response consists of a code and a message, which will help with diagnosing the issue with the request.

Error Code Error Message Description
400 Bad Request Returned if any invalid/unexpected query parameter/value is present in the request.
401 Unauthorized Returned if access_token used in request is invalid or expired.
403 Forbidden Returned if access_token does not have the required scope to use this API.
404 Not Found Returned if customer or application specified does not exist.
422 Unprocessable Entity Returned if the request payload is invalid
429 Too Many Requests Returned if rate limit has been exceeded
500 Internal Server Error Unknown error processing the request

Example error response

{
  "code": "401",
  "message": "Invalid access_token",
  "success": false
}