Error Codes

All errors return JSON with a status and message field.

401 — Token Missing

Returned when Authorization: Bearer <token> header is not sent.

{
  "status": "error",
  "message": "Authorization Bearer token is missing."
}

401 — Invalid Token

Returned when the token does not match any company in the database.

{
  "status": "error",
  "message": "Invalid Authorization Token."
}

403 — Account Suspended

Token is valid, but the company account is deactivated.

{
  "status": "error",
  "message": "Company account is suspended or inactive."
}

422 — Validation Error

Returned when query parameters are in an invalid format (e.g. type is not 1–4, or per_page is not an integer).

{
  "message": "The selected type is invalid. (and/or) The per page field must be an integer.",
  "errors": {
    "type": [
      "The selected type is invalid."
    ],
    "per_page": [
      "The per page field must be an integer."
    ]
  }
}

429 — Too Many Requests

Returned when the rate limit is exceeded. See Rate Limits.

{
  "message": "Too Many Attempts."
}