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

# Cycle Count - Get All

> Retrieve all cycle counts with optional filtering by status and warehouse.



## OpenAPI

````yaml get /cycle_count/get_all
openapi: 3.0.3
info:
  title: SKULabs API
  description: >-
    Most API keys have "platformGeneric" and "platformApi" scopes included.
    Contact us to convert more routes from "platformUser" (only available to
    users) to "platformGeneric" (available to users and api keys) upon request.
  version: 4.5.0
servers:
  - url: https://api.skulabs.com
  - url: https://app.skulabs.com/s
security: []
tags:
  - name: batch
  - name: customer
    description: Manage customers, tags, and notes
  - name: cycle_count
  - name: distributor
  - name: inventory
    description: Query and modify inventory levels across locations
  - name: inventory_table
  - name: item
    description: Manage items, barcodes, serial numbers, and tags
  - name: kit
    description: Manage kits and their component items
  - name: listing
  - name: location
  - name: oauth
  - name: order
    description: Manage orders, shipments, tags, and statuses
  - name: purchase_order
    description: Manage purchase orders and receiving
  - name: run
  - name: shipments
  - name: shipping
  - name: store
  - name: tag
    description: Create, update, and remove tags
  - name: transfer_order
  - name: warehouse
    description: Manage warehouses and view statistics
  - name: webhook
    description: Manage webhook handlers
paths:
  /cycle_count/get_all:
    get:
      tags:
        - cycle_count
      summary: Cycle Count - Get All
      description: >-
        Retrieve all cycle counts with optional filtering by status and
        warehouse.
      operationId: get_cycle_count_get_all
      parameters:
        - name: start
          in: query
          required: true
          schema:
            type: string
            description: Start date/time filter for log entries
            example: '2025-01-15T12:00:00.000Z'
        - name: end
          in: query
          required: true
          schema:
            type: string
            description: End date/time filter for log entries
            example: '2025-01-15T12:00:00.000Z'
      responses:
        '200':
          description: Array of cycle counts within the date range
          content:
            application/json:
              schema:
                type: object
                properties:
                  cycle_counts:
                    type: array
                    items:
                      $ref: '#/components/schemas/CycleCount'
                    description: Array of cycle counts
                required:
                  - cycle_counts
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
        '403':
          description: Forbidden. Insufficient permissions.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
        '429':
          description: Too many requests. Rate limit exceeded.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                        description: Detailed error message
                      code:
                        type: string
                        description: Machine-readable error code
                      overview:
                        type: string
                        description: Short human-friendly description
                      statusCode:
                        type: number
                        description: HTTP status code
                      origin:
                        type: string
                        description: Error source
                      skulabsTraceId:
                        type: string
                        description: Trace ID for support
                      type:
                        type: string
                        enum:
                          - error
                          - notice
                          - success
                        description: Error severity for UI handling
                      user_error:
                        type: boolean
                        description: Whether the error was caused by user input
                      display:
                        type: string
                        enum:
                          - notification
                          - panel
                        description: Suggested UI display mode for the error
                    required:
                      - message
                      - statusCode
                required:
                  - error
      security:
        - SKULabsToken: []
      servers:
        - url: https://api.skulabs.com
components:
  schemas:
    CycleCount:
      type: object
      properties:
        _id:
          type: string
          description: Unique cycle count identifier
          example: 507f1f77bcf86cd799439011
        account_id:
          type: string
          description: Account ID
          example: 507f1f77bcf86cd799439011
        number:
          type: number
          description: Auto-incremented cycle count number
        name:
          type: string
          description: Cycle count name
        warehouse_id:
          type: string
          description: Warehouse ID
          example: 507f1f77bcf86cd799439011
        location_id:
          type: string
          description: Location ID
          example: 507f1f77bcf86cd799439011
        status:
          type: string
          enum:
            - created
            - saved
          description: Cycle count status
        allow_ad_hoc:
          type: boolean
          description: Whether ad-hoc item scanning is allowed
        items:
          type: array
          items:
            $ref: '#/components/schemas/CycleCountItem'
          description: Items in the cycle count
        log:
          type: array
          items:
            $ref: '#/components/schemas/CycleCountLogEntry'
          description: Activity log entries
      required:
        - _id
        - number
        - warehouse_id
        - location_id
        - status
      description: Cycle count object
    CycleCountItem:
      type: object
      properties:
        item_id:
          type: string
          description: Item ID
          example: 507f1f77bcf86cd799439011
        quantity:
          type: number
          description: Counted quantity
        ad_hoc:
          type: boolean
          description: Whether the item was added ad-hoc during scanning
        note:
          type: string
          description: Note for this item
        delta:
          type: number
          description: Difference between scanned quantity and on-hand quantity
        old_on_hand:
          type: number
          description: On-hand quantity before cycle count was saved
        scanned_serial_numbers:
          type: array
          items:
            type: string
          description: Serial numbers scanned for this item
      required:
        - item_id
        - quantity
    CycleCountLogEntry:
      type: object
      properties:
        user_id:
          type: string
          nullable: true
          description: User ID who performed the action
          example: 507f1f77bcf86cd799439011
        action:
          type: string
          description: Action type (created, saved, etc.)
        time:
          type: string
          description: ISO 8601 timestamp of the action
          example: '2025-01-15T12:00:00.000Z'
      required:
        - action
        - time
  securitySchemes:
    SKULabsToken:
      type: http
      scheme: bearer
      bearerFormat: JWT

````