Retrieving Work Instructions
Production steps for a product (one set per product). MOs copy these into their own steps.
Use GET /api/v1/work-instructions to page through every record in your organization, or GET /api/v1/work-instructions/{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
Current Use Cases
Pull the steps for a product and display them at the station so operators build it the same way every time.
Export instructions into training docs so new hires learn the exact process the floor uses.
Use Cloudbox as the source for build steps and sync them to your document system.
Compare instructions over time to see when a product's build steps changed.
Required Headers
Every request must include the following:
Requests missing either header will return 401 Unauthorized
Example Request
Response Schema
Filters
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)