Retrieving Cycle Counts
Cycle-count sessions (container or SKU mode) with their counted lines.
Use GET /api/v1/cycle-counts to page through every record in your organization, or GET /api/v1/cycle-counts/{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 count sessions by status to see what's been counted and what's still due.
Compare each session's counted lines against expected stock to measure accuracy over time.
Filter by user_id to see every session a person ran.
Filter by mode to review container counts and SKU counts separately.
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)