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

# Exact quantities per location and lot.

> For a workspace TEST key this reads the workspace's seeded synthetic sandbox stock, never a real clinic's — same shape either way.



## OpenAPI

````yaml /openapi/ehr-api.v1.yaml get /v1/clinics/{clinic_id}/inventory/stock
openapi: 3.1.0
info:
  title: ClinikEHR API
  version: 1.0.0
  description: >-
    Server-to-server REST API for a clinic's own data, reached with a key the
    clinic (or a developer workspace) creates in the developer portal.


    Authenticate every request with `Authorization: Bearer <key>`. Test keys
    reach only your workspace's own synthetic sandbox; live keys reach the
    clinic that created them. Lists wrap their rows as `{ data, has_more,
    next_cursor }`; single resources are returned directly. Errors are
    `application/problem+json` (RFC 9457) with a stable `code`.


    Write requests accept an `Idempotency-Key` header so a retry never repeats a
    change. See the guides for authentication, permissions, pagination, rate
    limits and retries.
servers:
  - url: https://api.clinikehr.com/v1
security:
  - ApiKey: []
paths:
  /v1/clinics/{clinic_id}/inventory/stock:
    get:
      tags:
        - Inventory
      summary: Exact quantities per location and lot.
      description: >-
        For a workspace TEST key this reads the workspace's seeded synthetic
        sandbox stock, never a real clinic's — same shape either way.
      operationId: listInventoryStock
      parameters:
        - name: clinic_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: location_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: item_id
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: expiring_before
          in: query
          required: false
          schema:
            type: string
            format: date
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: starting_after
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - has_more
                  - next_cursor
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/InventoryStock'
                  has_more:
                    type: boolean
                  next_cursor:
                    type:
                      - string
                      - 'null'
              example:
                data:
                  - item_id: 9c1e6f2a-9b2b-4a36-8f6a-2f7b1e8b9a02
                    location_id: 6a9f7e3e-2b5a-4a86-8f0d-4a6a2b3c9a11
                    lot_id: lot_2026_09
                    quantity: '48'
                    reserved_quantity: '5'
                    expiry_date: '2027-03-01T00:00:00.000Z'
                    lot_status: active
                    as_of: '2026-09-20T10:00:00.000Z'
                has_more: false
                next_cursor: null
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
      security:
        - ApiKey: []
components:
  schemas:
    InventoryStock:
      type: object
      required:
        - item_id
        - quantity
      properties:
        item_id:
          type: string
          format: uuid
        location_id:
          type:
            - string
            - 'null'
          format: uuid
        lot_id:
          type:
            - string
            - 'null'
        quantity:
          type: string
          description: Decimal string.
        reserved_quantity:
          type: string
          description: >-
            Decimal string. Units already committed elsewhere — never counted as
            sellable.
        expiry_date:
          type:
            - string
            - 'null'
          format: date
          description: >-
            The lot's expiry date. Null for stock held without a lot, or a lot
            with none recorded.
        lot_status:
          type:
            - string
            - 'null'
          description: >-
            The lot's own status (e.g. active, quarantined, recalled). Null when
            there is no lot.
        as_of:
          type:
            - string
            - 'null'
          format: date-time
    Problem:
      type: object
      description: RFC 9457 application/problem+json.
      required:
        - type
        - title
        - status
        - code
        - request_id
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        code:
          type: string
        request_id:
          type: string
        errors:
          type: array
          items:
            type: object
            required:
              - pointer
              - message
            properties:
              pointer:
                type: string
              message:
                type: string
  responses:
    BadRequest:
      description: >-
        The request failed validation (unknown query parameter, limit out of
        range, malformed body).
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Unauthorized:
      description: >-
        Missing, malformed, unknown, revoked or expired key, or the wrong
        secret.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    Forbidden:
      description: >-
        The key or connection lacks the required scope, the plan does not
        include this resource, the request came from an address this key's IP
        allow-list does not permit, a TEST-environment workspace key asked for a
        clinic_id other than its own workspace's sandbox (`sandbox_only`), or a
        LIVE workspace key asked for a real clinic while its workspace's
        verification has lapsed (`not_verified`) — the response never names
        which addresses ARE allowed, nor which clinic actually is the sandbox.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    NotFound:
      description: The record is absent, or out of the key's scope — one message for both.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    TooManyRequests:
      description: Rate limited. See the Retry-After header.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: ehr_live_<keyId>_<secret> or ehr_test_<keyId>_<secret>

````

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