---
title: "List Cycle Counts"
method: GET
path: "/cycle-counts"
tags: ["cycle_count"]
---

# List Cycle Counts

`GET /cycle-counts`

## Request

- Base URL: `https://app.allocadence.com/rest`
- URL: `https://app.allocadence.com/rest/cycle-counts`
- Auth: none declared

Get a list of cycle counts based on search parameters.

## Query parameters

- `type` '' | 'normal' | 'adjustment'
- `inProgress` boolean
- `completed` boolean
- `approved` boolean
- `warehouseId` integer
- `warehouseName` string
- `createdFrom` string, date-time
- `createdTo` string, date-time
- `orderBy` '' | 'id' | 'createdDate'
- `orderDir` 'asc' | 'desc'
- `page` integer
- `perPage` integer

## Response `200`

Success

- CycleCountList
  - `cycleCounts` CycleCount[]
    - `id` integer
    - `adjustment` boolean
    - `progress` number
    - `accuracy` number
    - `warehouse` WarehouseCompact
      - `id` integer
      - `name` string
    - `createdDate` string, date-time
    - `createdBy` UserCompact
      - `id` integer
      - `name` string
    - `claimedBy` UserCompact
      - `id` integer
      - `name` string
    - `completed` boolean
    - `completedDate` string, date-time
    - `completedBy` UserCompact
      - `id` integer
      - `name` string
    - `approved` boolean
    - `approvedDate` string, date-time
    - `approvedBy` UserCompact
      - `id` integer
      - `name` string
    - `locations` CycleCountLocation[]
      - `id` integer
      - `location` LocationCompact
        - `id` integer
        - `name` string
      - `accuracy` number
      - `completed` boolean
      - `completedDate` string, date-time
      - `completedBy` UserCompact
        - `id` integer
        - `name` string
      - `approved` boolean
      - `approvedDate` string, date-time
      - `approvedBy` UserCompact
        - `id` integer
        - `name` string
  - `meta` PaginationMeta
    - `count` integer: Total number of objects in the result set.
    - `page` integer: The page of the result set in the response.
    - `perPage` integer: Number of objects per page.
    - `totalPages` integer: Total number of pages in the result set.

---

[API](https://skmtc.dev/allocadence/apis/allocadence-rest-api.md) · [All operations](https://skmtc.dev/allocadence/apis/allocadence-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/allocadence/apis/allocadence-rest-api/revisions/0bcd45f547a9?raw)