# List inventory messages

Returns a paginated list of Inventory Messages for the specified site. Supports filtering and sorting.

Endpoint: GET /site/{siteId}/ahds/v1/inventory-message
Version: 1.0
Security: bearer

## Path parameters:

  - `siteId` (number, required)
    Site identifier

## Query parameters:

  - `page` (number)
    Page number (0-indexed)

  - `pageSize` (number)
    Number of items per page

  - `sortBy` (string)
    Field to sort by
    Enum: "createdAt", "updatedAt", "body", "readAt", "sentAt", "subject"

  - `sortOrder` (string)
    Sort order
    Enum: "asc", "desc"

  - `body` (string)
    Full content of the message.

  - `channel` (string)
    Primary communication channel or medium for this message.
    Enum: "internal", "email", "sms", "phone", "push", "other"

  - `clientProvidedId` (string)
    Optional client-supplied identifier for idempotency or cross-system correlation.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `isPinned` (boolean)
    Whether this message is pinned or highlighted in the UI.

  - `priority` (string)
    Relative importance of the message.
    Enum: "low", "normal", "high", "urgent"

  - `relatedInventoryItemId` (string)
    Inventory item this message is primarily about, if applicable.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `relatedPurchaseOrderId` (string)
    Purchase order this message is related to, if applicable.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `relatedSupplierId` (string)
    Supplier this message is related to, if applicable.
    Example: "123e4567-e89b-12d3-a456-426614174000"

  - `status` (string)
    Current lifecycle status of the message.
    Enum: "draft", "sent", "received", "read", "archived", "cancelled"

  - `subject` (string)
    Short, human-readable subject or title of the message.

  - `type` (string)
    High-level classification of the message.
    Enum: "system", "user", "integration", "alert", "note"


## Response 200 fields

## Response 401 fields