Retrieve a paginated list of inventory items with optional filters

GET

/v1/items

Retrieves a paginated list of items. Supports filtering by category, active status, and sorting.

Request

Query Params

Responses

🟢200

application/json

Items retrieved successfully

Body

🟠400

🟠401

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://dev.api.fieldedge.com/open-api/v1/items?offset&limit&category&active&sort'

Response Example

200 - response

{
    "total": 2,
    "limit": 20,
    "offset": 0,
    "data": [
        {
            "type": "InventoryItem",
            "itemId": "8c0f8e45-1f4d-4e89-9a55-9e2c4c6b7a11",
            "name": "Copper Pipe",
            "cost": 12.5,
            "rate": 18.75,
            "active": true,
            "description": "High quality copper pipe used for plumbing.",
            "categoryId": "2f1c9d3e-6b7a-4c2e-8f11-1a2b3c4d5e66",
            "category": "HVAC",
            "imageUrl": "https://xplorstorage.blob.core.windows.net/items/8c0f8e45-1f4d-4e89-9a55-9e2c4c6b7a11.png",
            "taxable": true,
            "salesTaxcode": "5a7b3c2d-1e4f-4a9b-8c77-9d6e5f4a3b21"
        },
        {
            "type": "InventoryItem",
            "itemId": "3b72a9a1-9c3a-4f6e-b9a4-2e8b7f3d6c55",
            "name": "Air Filter",
            "cost": 5,
            "rate": 9.99,
            "active": true,
            "description": "Durable air filter for HVAC systems.",
            "categoryId": "7c9e2a11-3d44-4f8b-91aa-2c3d4e5f6a77",
            "category": "filters",
            "imageUrl": "https://xplorstorage.blob.core.windows.net/items/3b72a9a1-9c3a-4f6e-b9a4-2e8b7f3d6c55.png",
            "taxable": true,
            "salesTaxcode": "8b6d5c4a-3f2e-4a1b-9c88-7e6d5f4a3b22"
        }
    ]
}

Modified at 2026-03-19 11:30:01

Creates a new inventory item

Updates an existing inventory item