API Errors

Standard error formats

{
  "errors": {
    "key_with_error": [
      "Error Message"
    ]
  }
}

The API follows a standardized error response format, which may vary slightly depending on the specific route being used.

In general, error responses include an error key along with a code and a descriptive message.

Alternatively, some routes may return only the error key with a list of reasons for the failure.

info

Note: This is a error response format, which includes an error key with a list of reasons for the failure.

{
  "error": "Error message"
}

info

Note: This is a simplified error response format that may be used in some routes, containing just an error key with a message.

API Availability and Status Codes

Our API is designed to operate 24/7, consistently responding with the following HTTP status codes:

Code	Meaning
200	Ok
201	Created
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
422	Unprocessable Entity
500	Internal Server Error
503	Service Unavailable

warning

If a 500/503 occurs, please contact Attrus support as soon as possible. Include the following information to help us resolve the issue quickly:

The API route used, The request payload (if available), The reason for this request or business context, Screenshots, if possible, The exact time the error occurred (including timezone)

This information helps our team diagnose and fix the issue efficiently.