Error Codes

To recap, the API returns an HTTP status code 200 for all requests - even errors. Responses will have an ok=false field and will also include an error object with details like the error code and a message.

To review the request/response format, visit the Fetching Data page.

Understanding Errors

When a request fails, it will have the following format:

{
  "ok": false,
  "error": {
    "code": "not_found",
    "message": "User not found"
  },
  "meta": {
    "requestId": "df382w8yfte76trfw"
  }
}

Error Codes

Here is the full list of possible error codes:

• unauthorized - Authentication failure or your credentials do not authorize you to perform the action.
• invalid_request - The API request contains missing or invalid data.
• not_found - The requested or inferred resource was not found.
• too_many_requests - The credentials have exceeded the request limit in the given time period.
• server_error - The request failed because of an internal error. Try back later or send the X-Request-Id to the support team.

It is possible that more error codes are introduced in the future along with additional fields on the error object.

If possible, the API will include a helpful description so you can troubleshoot the error. For security purposes, some error messages are not emitted.

For help troubleshooting difficult errors, please contact the support team at [email protected] and be sure to include the Request Id (from either the response meta body or from the response header).

Next up, check out Webhooks »