Overview

Errors with the API can happen on occasion. Please refer to the status request to figure out whether the API is up and running or not. Otherwise, Theca will always return an error code with an explanation of what went wrong with a result. Errors are always returned as JSON coded responses. These contain additional links to the API documentation and in some cases a description of the error.

tip

Ensure the resilience of your website by planning error handling into your implementation plan. Account for scenarios where our services timeout or return error results.

This is an example of the error page of a request missing the /v1 before /search.

{
    "timestamp": "2023-03-07T12:43:28",
    "status": 404,
    "error": "Not Found",
    "path": "/search",
    "documentation": "https://docs.theca.com/api/search/parameters",
    "help": "https://docs.theca.com/errors/codes#notfound"
}