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

# cycleCounts

> List cycle counts, newest first, optionally filtered by status, warehouse, assignee or date. Filters combine with AND. This reads the database directly, so it is always current: sync from it with `updatedAtAfter`.

**Required scopes:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**Store must have one of:** `IMS`

## Arguments

**after** `String`

Forward pagination cursor — returns cycle counts after it.

**assignedRole** `String`

Only counts assigned to this role.

**assigneeId** `ID`

Only counts assigned to this team member. A count assigned to a role has no assignee.

**before** `String`

Backward pagination cursor — returns cycle counts before it.

**createdAtAfter** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Only counts created at or after this instant.

**createdAtBefore** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Only counts created before this instant.

**dueAtAfter** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Only counts due at or after this instant.

**dueAtBefore** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Only counts due before this instant.

**first** `Int`

Forward pagination: returns the first N cycle counts (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N cycle counts (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**locationId** `ID`

Only counts taken at this warehouse. List warehouses with `locations`.

**orderBy** `[CycleCountSortKey](/docs/api-reference/v3/reference/inventory/cycle-count-sort-key)`

Which key to sort by (defaults to the first key, newest-first). Combine with `reverse` to flip direction.

**reverse** `Boolean`

Reverses the sort direction selected by `orderBy` (or its default).

**status** `[\[CycleCountStatus!\]](/docs/api-reference/v3/reference/inventory/cycle-count-status)`

Only counts in one of these statuses. Omit or leave empty for every status.

**updatedAtAfter** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Only counts updated at or after this instant.

**updatedAtBefore** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

Only counts updated before this instant.

## Returns

**cycleCounts** `[CycleCountConnection!](/docs/api-reference/v3/pagination)` *required*

A paginated list of CycleCount items.

**fields**

**edges** `[\[CycleCountEdge!\]!](/docs/api-reference/v3/pagination)` *required*

The list of edges (each a node plus its pagination `cursor`).

**fields**

**cursor** `String!` *required*

Opaque cursor for this item; pass to `after`/`before` to page from here.

**node** `[CycleCount!](/docs/api-reference/v3/reference/inventory/cycle-count)` *required*

The item at this edge.

**fields**

**assignedRole** `String`

The role whose members are asked to do the count. Null when it isn't assigned to a role.

**assignee** `[TeamMember](/docs/api-reference/v3/reference/common/team-member)`

The team member the count is assigned to. Null when it is unassigned or assigned to a role, or when they've left the team.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**binCount** `Int!` *required*

How many of the count's plans are bins.

**completedAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the count was completed. Null until then.

**createdAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the count was created.

**dueAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the count is due. Null when it has no due date.

**finishedPlanCount** `Int!` *required*

How many of the count's products and bins have been fully counted.

**id** `ID!` *required*

The id of this cycle count.

**location** `[Location](/docs/api-reference/v3/reference/inventory/location)`

The warehouse the count is taken in.

**Requires:** [`locations_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-locations_read)

**name** `String`

The count's display name, such as the rule that made it and the date. Null when it has none.

**planCount** `Int!` *required*

How many products and bins the count covers. Progress is `finishedPlanCount` out of this.

**plans** `[CycleCountPlanConnection!](/docs/api-reference/v3/pagination)` *required*

The products and bins the count covers, with when each started and finished.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns plans after it.

**before** `String`

Backward pagination cursor — returns plans before it.

**first** `Int`

Forward pagination: returns the first N plans (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N plans (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**productCount** `Int!` *required*

How many of the count's plans are products.

**source** `[CycleCountSource!](/docs/api-reference/v3/reference/inventory/cycle-count-source)` *required*

Whether a rule or a person created the count.

**startedAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When counting started: the count's own start, else the first plan to start. Null before that.

**status** `[CycleCountStatus!](/docs/api-reference/v3/reference/inventory/cycle-count-status)` *required*

Where the count is in its lifecycle.

**updatedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the count was last updated.

**variance** `Int!` *required*

Units counted away from what was expected, summed over everything counted so far, whether short or over. 0 until something is counted.

**nodes** `[\[CycleCount!\]!](/docs/api-reference/v3/reference/inventory/cycle-count)` *required*

The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

**fields**

**assignedRole** `String`

The role whose members are asked to do the count. Null when it isn't assigned to a role.

**assignee** `[TeamMember](/docs/api-reference/v3/reference/common/team-member)`

The team member the count is assigned to. Null when it is unassigned or assigned to a role, or when they've left the team.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**fields**

**email** `String`

Email address. Null when the user has none.

**id** `ID!` *required*

m\_us\_… id, the same id the app and MCP tools use.

**name** `String`

Display name. Null when the user hasn't set one.

**supportShiftStatus** `[SupportShiftStatus!](/docs/api-reference/v3/reference/support/support-shift-status)` *required*

The agent's live shift status, worked out when the request runs.

**Requires:** [`support_config_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-support_config_read)

**supportWorkSchedule** `[SupportWorkSchedule!](/docs/api-reference/v3/reference/support/support-work-schedule)` *required*

The agent's support working hours. An agent with no saved schedule returns enabled false.

**Requires:** [`team_members_manage`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-team_members_manage)

**binCount** `Int!` *required*

How many of the count's plans are bins.

**completedAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the count was completed. Null until then.

**createdAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the count was created.

**dueAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When the count is due. Null when it has no due date.

**finishedPlanCount** `Int!` *required*

How many of the count's products and bins have been fully counted.

**id** `ID!` *required*

The id of this cycle count.

**location** `[Location](/docs/api-reference/v3/reference/inventory/location)`

The warehouse the count is taken in.

**Requires:** [`locations_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-locations_read)

**fields**

**city** `String`

The city of the location's address.

**company** `String`

The company name associated with the location.

**countryCode** `String`

The country code, e.g. "US".

**createdAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the record was created.

**id** `ID!` *required*

The id of this location.

**inventoryItems** `[InventoryItemConnection!](/docs/api-reference/v3/pagination)` *required*

Traceable inventory units at this warehouse.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.

**before** `String`

Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.

**first** `Int`

Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**inventoryLevels** `[LocationInventoryLevelConnection!](/docs/api-reference/v3/pagination)` *required*

Per-product inventory levels held at this location.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.

**before** `String`

Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.

**first** `Int`

Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**name** `String!` *required*

The location's display name.

**phone** `String`

The contact phone number for the location.

**postalCode** `String`

The postal or ZIP code, e.g. "84101".

**stateCode** `String`

The state or province code, e.g. "UT".

**storageLocations** `[StorageLocationConnection!](/docs/api-reference/v3/pagination)` *required*

Bins and other storage locations within this warehouse.

**Requires:** [`locations_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-locations_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.

**before** `String`

Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.

**first** `Int`

Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**street1** `String`

The first line of the street address.

**street2** `String`

The second line of the street address.

**updatedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the record was last updated.

**name** `String`

The count's display name, such as the rule that made it and the date. Null when it has none.

**planCount** `Int!` *required*

How many products and bins the count covers. Progress is `finishedPlanCount` out of this.

**plans** `[CycleCountPlanConnection!](/docs/api-reference/v3/pagination)` *required*

The products and bins the count covers, with when each started and finished.

**Requires:** [`inventory_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-inventory_read)

**fields**

**Arguments**

**after** `String`

Forward pagination cursor — returns plans after it.

**before** `String`

Backward pagination cursor — returns plans before it.

**first** `Int`

Forward pagination: returns the first N plans (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.

**last** `Int`

Backward pagination: returns the last N plans (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.

**Fields**

**edges** `[\[CycleCountPlanEdge!\]!](/docs/api-reference/v3/pagination)` *required*

The list of edges (each a node plus its pagination `cursor`).

**nodes** `[\[CycleCountPlan!\]!](/docs/api-reference/v3/reference/inventory/cycle-count-plan)` *required*

The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.

**pageInfo** `[PageInfo!](/docs/api-reference/v3/pagination)` *required*

Pagination metadata for the current page.

**productCount** `Int!` *required*

How many of the count's plans are products.

**source** `[CycleCountSource!](/docs/api-reference/v3/reference/inventory/cycle-count-source)` *required*

Whether a rule or a person created the count.

**startedAt** `[DateTime](/docs/api-reference/v3/reference/common/date-time)`

When counting started: the count's own start, else the first plan to start. Null before that.

**status** `[CycleCountStatus!](/docs/api-reference/v3/reference/inventory/cycle-count-status)` *required*

Where the count is in its lifecycle.

**updatedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the count was last updated.

**variance** `Int!` *required*

Units counted away from what was expected, summed over everything counted so far, whether short or over. 0 until something is counted.

**pageInfo** `[PageInfo!](/docs/api-reference/v3/pagination)` *required*

Pagination metadata for the current page.

**fields**

**endCursor** `String`

Cursor of the last edge in this page; pass to `after` to page forward.

**hasNextPage** `Boolean!` *required*

Whether more items exist after this page (drives forward pagination with `first`/`after`).

**hasPreviousPage** `Boolean!` *required*

Whether more items exist before this page (drives backward pagination with `last`/`before`).

**startCursor** `String`

Cursor of the first edge in this page; pass to `before` to page backward.

## Example

```graphql theme={null}
query {
  cycleCounts(after: "...", assignedRole: "...", assigneeId: "...", before: "...", createdAtAfter: "...", createdAtBefore: "...", dueAtAfter: "...", dueAtBefore: "...", first: 10, last: 10, locationId: "...", orderBy: CREATED_AT, reverse: true, status: CANCELLED, updatedAtAfter: "...", updatedAtBefore: "...") {
    nodes {
      assignedRole
      binCount
      completedAt
      createdAt
      dueAt
      finishedPlanCount
      id
      name
      # ...
    }
    pageInfo { hasNextPage endCursor }
  }
}
```


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