Errors, Rate Limits & Status Codes

Deskbolic uses conventional HTTP response codes to indicate the success or failure of an API request.

HTTP Status Codes

CodeMeaningDescription
200 OKSuccessRequest completed successfully.
201 CreatedResource CreatedNew record created successfully.
400 Bad RequestInvalid RequestMalformed parameters or body.
401 UnauthorizedAuthentication RequiredMissing or invalid API key/JWT.
402 Payment RequiredSubscription InactiveAccount subscription limit reached or expired.
403 ForbiddenAccess DeniedPermission denied or API channel feature not enabled.
404 Not FoundNot FoundThe requested resource does not exist.
422 UnprocessableValidation ErrorValidation failed on resource attributes.
500 Server ErrorInternal ErrorServer encountered an error.

Error Response Format

{
  "errors": [
    {
      "code": "not_found",
      "message": "Resource not found"
    }
  ]
}