Inventory

Retrieve all inventory items.

Get a list of all inventory items.

get/inventory

Request

  • Base URL: https://api.floorworks.co.uk/api/v1
  • URL: https://api.floorworks.co.uk/api/v1/inventory
  • Auth: OAuth 2 (password, token URL https://api.floorworks.co.uk/api/v1/auth)

Query parameters

order_field'code' | 'name' | 'description_status' | 'rating' | 'qty' | 'price' | 'amount_per_unit'

Field to sort results by.

srch_time'time_created' | 'time_modified'

Search date field.

srch_stock_type'PRODUCT' | 'SERVICE' | 'ASSET' | 'STANDARD'

Filter by stock type.

srch_categoryinteger

Filter by category ID.

srch_active0 | 1

Filter by active status.

srch_date_fromstring d/m/Y

Search by start date

srch_date_tostring d/m/Y

Search by end date

page_sizenumber

Results per page

pagenumber

Current page

order_direction'DESC' | 'ASC'

Sort results ascending or descending

Response

List of all inventory items

Example response

[
  {
    "id": 12345,
    "time_created": "2025-08-17",
    "time_modified": "2025-08-18"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.