Operations API

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

Retrieving Operations

Routing: the planned operations (with resource, minutes, and cost) to make a product/SKU. MOs copy these into their own operations.

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

API Endpoint

GET
/api/v1/operations
GET
/api/v1/operations/{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/operations?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
product_id
string, nullable
References Product. Filterable (exact)
sku_id
string
References SKU. Filterable (exact)
step_number
integer
Sortable
name
string
description
string, nullable
resource_id
string (uuid), nullable
References Resources. Filterable (exact)
planned_minutes
number, nullable
planned_cost
number, nullable
created_at
string (ISO 8601)
Creation timestamp (UTC). Sortable
updated_at
string (ISO 8601)
Last update timestamp (UTC)
resource
object
Detail endpoint only. Related record: id, name, type, hourly_rate

Filters

limitPage size (default 100, max 1000)
offsetNumber of records to skip (default 0)
sortOne of: step_number, created_at
orderasc | desc
sku_idOperations for this SKU
product_idOperations for this product
resource_idOperations using this resource
default sortstep_number ascending

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)