Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrubbe.com/llms.txt

Use this file to discover all available pages before exploring further.

When a request cannot be completed, the Scrubbe API returns a non-2xx HTTP status code alongside a JSON body that explains what went wrong. Every error response follows the same structure so you can handle failures consistently regardless of the endpoint.

​
Error response format

​
success
boolean
required
Always false for error responses.
​
message
string
required
A human-readable summary of the error.
​
errors
string[]
required
An array of specific validation messages or detail strings. May be empty for server-side errors, but is always present.
{
  "success": false,
  "message": "Validation failed.",
  "errors": ["email is required", "password must be at least 8 characters"]
}

​
HTTP status codes

​
400 Bad Request

The request was malformed or failed server-side validation. Inspect the errors array for field-level details. 
{
  "success": false,
  "message": "Validation failed.",
  "errors": [
    "priority must be one of LOW, MEDIUM, HIGH, CRITICAL",
    "summary is required"
  ]
}
Common causes:
  • Missing required fields in the request body
  • Invalid enum values (e.g., wrong priority or status)
  • Malformed JSON body
  • Invalid date/time format
Remediation: Re-read the endpoint’s parameter documentation, fix the offending fields, and resubmit.

​
401 Unauthorized

No valid credentials were supplied, or the access token has expired. 
{
  "success": false,
  "message": "Authentication required.",
  "errors": []
}
Common causes:
  • Missing Authorization or X-API-Key header
  • Expired access token
  • Invalid or malformed Bearer token format
Access tokens are short-lived. Call POST /auth/refresh-token with your refresh token to obtain a new access token without prompting the user to log in again.

​
403 Forbidden

The credentials are valid but the caller lacks permission for the requested resource or action. 
{
  "success": false,
  "message": "You do not have permission to perform this action.",
  "errors": []
}
Common causes:
  • API key is missing a required scope (e.g., incidents:write)
  • User role does not permit the operation
  • Accessing a resource that belongs to a different workspace
Remediation: Check the required scopes listed on the endpoint’s documentation page, then rotate your API key with the correct scopes or ask a workspace admin to update your role.

​
404 Not Found

The requested resource does not exist or has been deleted. 
{
  "success": false,
  "message": "Incident not found.",
  "errors": []
}
Common causes:
  • Incorrect or stale resource ID in the URL path
  • Resource was deleted by another actor
  • Typo in the endpoint URL
Remediation: Confirm the resource ID by listing the relevant collection before retrying with the correct value.

​
409 Conflict

The request conflicts with the current state of the resource on the server. 
{
  "success": false,
  "message": "A user with this email address already exists.",
  "errors": []
}
Common causes:
  • Duplicate registration using an email that is already in use
  • Attempting to accept an invite that has already been used
  • Re-rotating an API key that is already in a pending state
Remediation: Fetch the existing resource before creating a duplicate, or handle the 409 response and surface an appropriate message to the user.

​
429 Too Many Requests

The caller has exceeded the rate limit for the applicable scope. Wait until the window resets before retrying. 
{
  "success": false,
  "message": "Too many requests. Please try again later.",
  "errors": []
}
ScopeLimitWindow
Global200 requests15 min
Auth10 requests15 min
Email OTP3 requests1 min
API Key100 requests1 min
Do not retry immediately after a 429. Read the Retry-After response header and wait the specified number of seconds. Implement exponential backoff to avoid repeated rejections.

​
500 Internal Server Error

An unexpected condition occurred on the server. These errors are not caused by client input. 
{
  "success": false,
  "message": "An internal error occurred. Please try again.",
  "errors": []
}
Remediation: Retry the request after a short delay. If the error persists, check the Scrubbe status page or contact support with the request timestamp and any correlation ID from the response headers.

​
Handling errors in code

The following examples show a consistent pattern for inspecting error responses across languages. 
const response = await fetch('https://your-api-domain.com/api/v1/incident-ticket', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': `Bearer ${token}`
  },
  body: JSON.stringify(payload)
});

if (!response.ok) {
  const error = await response.json();
  console.error(`[${response.status}] ${error.message}`, error.errors);
}