Alerts API

Get access to your alerts data through Cloudbox's v1 API.

Retrieving Alerts

Stock, weight, and device alerts.

Use GET /api/v1/alerts to page through every record in your organization, or GET /api/v1/alerts/{id} to fetch a single record. The id is a UUID, and a 404 means it doesn't exist in your organization.

API Endpoint

GET
/api/v1/alerts
GET
/api/v1/alerts/{id}

Required Headers

Every request must include the following:

Header Key
Description
org-api-key
Your Organization API key. Contact Cloudbox Support For Access: support@cloudboxapp.com.
user-api-key
Your User API Key

Requests missing either header will return 401 Unauthorized

Example Request

bash curl -X GET "https://app.cloudboxapp.com/api/v1/alerts?limit=100" \ -H "org-api-key: YOUR_ORG_API_KEY" \ -H "user-api-key: YOUR_USER_API_KEY" \ -H "Accept: application/json"

Response Schema

Column
Type
Description
id
string (uuid)
Unique ID
type
string, nullable
Filterable (exact)
message
string
container_id
string, nullable
References Containers. Filterable (exact)
base_id
string, nullable
References Bases
sku_id
string, nullable
References SKU. Filterable (exact)
weight
number, nullable
units
integer, nullable
viewed
boolean, nullable
Filterable (exact)
created_at
string (ISO 8601), nullable
Creation timestamp (UTC). Sortable

Filters

limitPage size (default 100, max 1000)
offsetNumber of records to skip (default 0)
sortOne of: created_at
orderasc | desc
typeAlert type
viewedOnly viewed (true) or unviewed (false) (boolean)
sku_idAlerts for this SKU
container_idAlerts for this container
created_sinceOnly records created at or after this ISO 8601 timestamp
default sortcreated_at descending

Errors

Cloudbox uses standard HTTP status codes to indicate API success or failure:

  • 200–299 – Request succeeded
  • 400 – Bad request (missing parameters, invalid values)
  • 401 – Unauthorized (missing or invalid API keys)
  • 404 – Resource not found
  • 429 – Too many requests (rate limited)