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

# List scan sessions

> List the caller's scan sessions, newest first. An API key sees its organization's sessions; any other credential sees the sessions it opened. Paginated with the standard ``{data, pagination}`` envelope; default ``page_size`` is 25, max 100.



## OpenAPI

````yaml /openapi/openapi-scanner.json get /scanner/api/v1/sessions
openapi: 3.1.0
info:
  title: Scanner API
  version: 1.0.0
  description: >
    Barcode and product scanning with vision extraction.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Scanner Sessions
    description: Create and manage barcode scanning sessions.
  - name: Scanner Captures
    description: Record barcode scan captures within sessions.
  - name: Scanner Enrichment
    description: Enrich scanned items with product data.
  - name: Scanner Photos
    description: Manage photos attached to scan sessions.
  - name: Scanner Upload
    description: Upload scan data in bulk.
  - name: Scanner Resolve
    description: >-
      Dual-scan QR resolve: follow QR redirect chains and save the canonical URL
      as a trade-item redirect (C-503).
  - name: Scanner Freshness
    description: >-
      Resolve color-coded freshness-chip thresholds for a scanned GTIN from the
      GPC-brick category config (C-2987). Anonymous-allowed; consumed by the
      public /scan/ overlay.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /scanner/api/v1/sessions:
    get:
      tags:
        - Scanner Sessions
      summary: List scan sessions
      description: >-
        List the caller's scan sessions, newest first. An API key sees its
        organization's sessions; any other credential sees the sessions it
        opened. Paginated with the standard ``{data, pagination}`` envelope;
        default ``page_size`` is 25, max 100.
      operationId: apps_scanner_api_session_endpoints_list_sessions
      parameters:
        - in: query
          name: page
          schema:
            default: 1
            description: Page number (1-indexed).
            minimum: 1
            title: Page
            type: integer
          required: false
          description: Page number (1-indexed).
        - in: query
          name: page_size
          schema:
            default: 25
            description: Number of items per page (max 100).
            maximum: 100
            minimum: 1
            title: Page Size
            type: integer
          required: false
          description: Number of items per page (max 100).
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedSessionResponseSchema'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '405':
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '422':
          description: Unprocessable Content
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - CookieGatedSessionAuth: []
components:
  schemas:
    PagedSessionResponseSchema:
      properties:
        data:
          description: >-
            Items on the current page, each conforming to the endpoint's item
            schema. Empty when the result set is empty or ``page`` is past the
            end.
          items:
            $ref: '#/components/schemas/SessionResponseSchema'
          title: Data
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationMeta'
          description: Pagination envelope describing position within the full result set.
      required:
        - data
        - pagination
      title: PagedSessionResponseSchema
      type: object
    ErrorOut:
      description: |-
        RFC 9457 Problem Details response.

        All API errors are returned in this format with Content-Type:
        application/problem+json.
      examples:
        - detail: The requested resource was not found.
          error_code: not_found
          retryable: false
          status: 404
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Not Found
          type: https://closient.com/docs/errors/not_found
        - detail: Validation error.
          details:
            - loc:
                - body
                - name
              msg: Field required
              type: missing
          error_code: validation_error
          retryable: false
          status: 422
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Validation Error
          type: https://closient.com/docs/errors/validation_error
        - detail: Rate limit exceeded. Please try again later.
          error_code: rate_limited
          retry_after: 31
          retryable: true
          status: 429
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Rate Limited
          type: https://closient.com/docs/errors/rate_limited
      properties:
        type:
          description: URI reference identifying the error type.
          title: Type
          type: string
        title:
          description: Short human-readable summary of the error.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation of this specific occurrence.
          title: Detail
          type: string
        error_code:
          description: Machine-readable error code (e.g. not_found, unauthorized).
          title: Error Code
          type: string
        retryable:
          default: false
          description: Whether retrying the same request can succeed.
          title: Retryable
          type: boolean
        timestamp:
          description: ISO 8601 timestamp of when the error occurred.
          title: Timestamp
          type: string
        retry_after:
          anyOf:
            - type: integer
            - type: 'null'
          description: Seconds to wait before retrying (when applicable).
          title: Retry After
        owner_action_required:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the error requires account owner intervention.
          title: Owner Action Required
        details:
          description: Additional context (validation errors, etc.).
          title: Details
      required:
        - type
        - title
        - status
        - detail
        - error_code
        - timestamp
      title: ErrorOut
      type: object
    SessionResponseSchema:
      description: Scan session summary.
      examples:
        - capture_count: 5
          capture_mode: barcode_scan
          created: '2025-08-15T14:00:00Z'
          id: keATfB8VP2gSjcnTbsMNQL
          metadata:
            order_id: '6735'
          modified: '2025-08-15T14:30:00Z'
          photo_count: 3
          status: active
      properties:
        metadata:
          additionalProperties:
            maxLength: 500
            type: string
          description: >-
            Developer-attached key/value data attached to this object. Up to 50
            keys; key max 40 chars, value max 500 chars.
          maxProperties: 50
          propertyNames:
            maxLength: 40
          title: Metadata
          type: object
        id:
          description: Unique session identifier.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        status:
          $ref: '#/components/schemas/SessionStatusEnum'
          description: >-
            Lifecycle state of the session. ``ACTIVE`` while the operator is
            still adding captures; ``COMPLETED`` once they explicitly end or
            submit it; ``EXPIRED`` if a maintenance job reaped the session after
            sitting idle past its TTL.
        capture_mode:
          $ref: '#/components/schemas/CaptureModeEnum'
          description: Session capture mode.
        created:
          description: Timestamp when the session was created.
          format: date-time
          title: Created
          type: string
        modified:
          description: Timestamp when the session was last modified.
          format: date-time
          title: Modified
          type: string
        capture_count:
          default: 0
          description: Total number of captures.
          title: Capture Count
          type: integer
        photo_count:
          default: 0
          description: Total number of product photos.
          title: Photo Count
          type: integer
      required:
        - id
        - status
        - capture_mode
        - created
        - modified
      title: SessionResponseSchema
      type: object
    PaginationMeta:
      description: >-
        Page envelope returned alongside ``data`` on every paginated list
        endpoint.
      examples:
        - has_next: true
          has_previous: false
          page: 1
          page_size: 25
          total_count: 342
          total_pages: 14
      properties:
        page:
          description: >-
            1-indexed page number that was returned. Echoes the ``?page=`` query
            parameter.
          examples:
            - 1
          minimum: 1
          title: Page
          type: integer
        page_size:
          description: >-
            Number of items returned in ``data`` for this page. Capped at the
            endpoint's ``max_page_size`` (typically 100).
          examples:
            - 25
          minimum: 1
          title: Page Size
          type: integer
        total_count:
          description: Total number of items matching the query across all pages.
          examples:
            - 342
          minimum: 0
          title: Total Count
          type: integer
        total_pages:
          description: >-
            Total number of pages at the current ``page_size``. Always at least
            1 (an empty result still reports ``total_pages: 1``).
          examples:
            - 14
          minimum: 1
          title: Total Pages
          type: integer
        has_next:
          description: >-
            True when ``page < total_pages`` — clients can request
            ``page=page+1`` to continue.
          examples:
            - true
          title: Has Next
          type: boolean
        has_previous:
          description: >-
            True when ``page > 1`` — clients can request ``page=page-1`` to go
            back.
          examples:
            - false
          title: Has Previous
          type: boolean
      required:
        - page
        - page_size
        - total_count
        - total_pages
        - has_next
        - has_previous
      title: PaginationMeta
      type: object
    SessionStatusEnum:
      description: |-
        Lifecycle state of a scan session.

        Mirrors :class:`apps.scanner.models.ScanSession.Status`. New sessions
        start ``ACTIVE``; a session is moved to ``COMPLETED`` by the explicit
        end endpoint, or to ``EXPIRED`` by a maintenance job that
        reaps sessions which sat idle past their TTL.
      enum:
        - ACTIVE
        - COMPLETED
        - EXPIRED
      title: SessionStatusEnum
      type: string
    CaptureModeEnum:
      enum:
        - barcode_scan
        - product_photography
        - both
      title: CaptureModeEnum
      type: string
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    CookieGatedSessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````