Errors

In this guide, we'll cover what happens when issues arise while using the API. Mistakes are a part of the process, and we strive to provide comprehensive details about any problems that may occur. Let's look into various status codes and messages that you may come across.

To determine the success of your request, simply check the status code in the API response. If the response indicates a failure, refer to the accompanying error message to diagnose the issue and make necessary adjustments.

Before contacting support, we recommend giving your implementation another thorough look. We make every effort to provide extensive information when things don't go as planned, so reaching out to support may not always be necessary if you can identify and resolve the problem using the details we provide.

Status codes

The API's status codes fall into distinct categories:

  • Name
    2xx
    Type
    Description

    A 2xx status code signifies a successful response.

  • Name
    4xx
    Type
    Description

    A 4xx status code points to a client error.

  • Name
    5xx
    Type
    Description

    A 5xx status code indicates a server error.

Error types

Whenever you receive a response from the API, it will consistently include status and message attributes in case of an error. Otherwise, you will find status and data attributes. Utilize this information to gain a clearer insight into any issues that might have occurred and how to address them. Our error messages are designed to be informative and actionable, helping you navigate through potential obstacles effectively.

Error response

{
  "status": "error",
  "message": "The given data was invalid.",
  "data": [
    "username": [
      "The username field is required."
    ]
  ]
}