> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stateset.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List cycle counts

> List cycle counts

<Warning>
  **Confirm your deployment before running this request.** This page describes an API contract;
  a published reference does not establish hosted availability. Check the dated
  [host report](/api-reference/hosts) and obtain your deployment URL and credentials.
  Replace the example host if your provisioned service uses a different URL.
</Warning>

### Query parameters

<ParamField query="warehouse_id" type="integer (int32)" />

<ParamField query="location_id" type="integer (int32)" />

<ParamField query="status" type="string">
  One of `draft`, `in_progress`, `completed`, `cancelled`.
</ParamField>

<ParamField query="limit" type="integer (int32)" />

<ParamField query="offset" type="integer (int32)" />

<ParamField query="after" type="string">
  Cursor for keyset pagination (opaque token from `next_cursor`).
</ParamField>

### Response

`CycleCountListResponse`

<ResponseField name="cycle_counts" type="CycleCountResponse[]" required>
  <Expandable title="CycleCountResponse">
    <ResponseField name="completed_at" type="string,null" />

    <ResponseField name="counted_by" type="string,null" />

    <ResponseField name="created_at" type="string" required />

    <ResponseField name="id" type="string" required />

    <ResponseField name="lines" type="CycleCountLineResponse[]" required>
      <Expandable title="CycleCountLineResponse">
        <ResponseField name="counted_quantity" type="string,null" />

        <ResponseField name="expected_quantity" type="string" required />

        <ResponseField name="id" type="string" required />

        <ResponseField name="lot_id" type="string,null" />

        <ResponseField name="sku" type="string" required />

        <ResponseField name="variance" type="string,null" />
      </Expandable>
    </ResponseField>

    <ResponseField name="location_id" type="integer,null (int32)" />

    <ResponseField name="scheduled_date" type="string,null" />

    <ResponseField name="status" type="string" required />

    <ResponseField name="updated_at" type="string" required />

    <ResponseField name="warehouse_id" type="integer (int32)" required />
  </Expandable>
</ResponseField>

<ResponseField name="has_more" type="boolean" required>
  Whether more results are available after this page.
</ResponseField>

<ResponseField name="next_cursor" type="string,null">
  Opaque cursor for fetching the next page (keyset pagination).
</ResponseField>

<ResponseField name="total" type="integer" required>
  Minimum: `0`.
</ResponseField>

### Status codes

| Code | Meaning |
| - | - |
| `200` | — |

### Using this contract

Read the [source OpenAPI document](/spec/stateset-icommerce.json) for declared schemas and alternatives.
This page also includes documented corrections from the [spec overlays](https://github.com/stateset/docs/tree/main/spec/overlays).
Example IDs and values are illustrative; replace them with records from your workspace.

<RequestExample>
  ```bash cURL theme={null}
  curl --silent --show-error --fail-with-body --request GET \
    --url 'https://api.stateset.com/api/v1/cycle-counts' \
    --header "Authorization: Bearer $STATESET_API_KEY"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "cycle_counts": [
      {
        "completed_at": "2026-08-31T14:22:05Z",
        "counted_by": "string",
        "created_at": "2026-08-31T14:22:05Z",
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "lines": [
          {
            "counted_quantity": "string",
            "expected_quantity": "string",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "lot_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "sku": "SKU-TENT-2P-GRN",
            "variance": "string"
          }
        ],
        "location_id": 1001,
        "scheduled_date": "2026-08-31T14:22:05Z",
        "status": "pending",
        "updated_at": "2026-08-31T14:22:05Z",
        "warehouse_id": 1001
      }
    ],
    "has_more": true,
    "next_cursor": "string",
    "total": 102
  }
  ```
</ResponseExample>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.